The cluster data source provides information about an existing HCP Consul cluster.
data "hcp_consul_cluster" "example" {
cluster_id = var.cluster_id
}
cluster_id
(String) The ID of the HCP Consul cluster.project_id
(String) The ID of the HCP project where the HCP Consul cluster is located.
If not specified, the project specified in the HCP Provider config block will be used, if configured.
If a project is not configured in the HCP Provider config block, the oldest project in the organization will be used.timeouts
(Block, Optional) (see below for nested schema)auto_hvn_to_hvn_peering
(Boolean) Enables automatic HVN to HVN peering when creating a secondary cluster in a federation.cloud_provider
(String) The provider where the HCP Consul cluster is located. Only 'aws' is available at this time.connect_enabled
(Boolean) Denotes the Consul connect feature should be enabled for this cluster. Default to true.consul_automatic_upgrades
(Boolean) Denotes that automatic Consul upgrades are enabled.consul_ca_file
(String) The cluster CA file encoded as a Base64 string.consul_config_file
(String) The cluster config encoded as a Base64 string.consul_private_endpoint_url
(String) The private URL for the Consul UI.consul_public_endpoint_url
(String) The public URL for the Consul UI. This will be empty if public_endpoint
is false
.consul_snapshot_interval
(String) The Consul snapshot interval.consul_snapshot_retention
(String) The retention policy for Consul snapshots.consul_version
(String) The Consul version of the cluster.datacenter
(String) The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id
.hvn_id
(String) The ID of the HVN this HCP Consul cluster is associated to.id
(String) The ID of this resource.ip_allowlist
(List of Object) Allowed IPV4 address ranges (CIDRs) for inbound traffic. Each entry must be a unique CIDR. Maximum 3 CIDRS supported at this time. (see below for nested schema)organization_id
(String) The ID of the organization the project for this HCP Consul cluster is located.primary_link
(String) The self_link
of the HCP Consul cluster which is the primary in the federation setup with this HCP Consul cluster. If not specified, it is a standalone cluster.public_endpoint
(Boolean) Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.region
(String) The region where the HCP Consul cluster is located.scale
(Number) The the number of Consul server nodes in the cluster.self_link
(String) A unique URL identifying the HCP Consul cluster.size
(String) The t-shirt size representation of each server VM that this Consul cluster is provisioned with. Valid option for development tier - x_small
. Valid options for other tiers - small
, medium
, large
. For more details - https://cloud.hashicorp.com/pricing/consulstate
(String) The state of the HCP Consul cluster.tier
(String) The tier that the HCP Consul cluster will be provisioned as. Only development
, standard
, plus
, and premium
are available at this time.timeouts
Optional:
default
(String)ip_allowlist
Read-Only:
address
(String)description
(String)