1. Packages
  2. HCP
  3. API Docs
  4. ConsulCluster
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security

hcp.ConsulCluster

Explore with Pulumi AI

hcp logo
HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security

    Consul on Azure is now available in public beta. Get started with end-to-end deployment configuration.

    The Consul cluster resource allows you to manage an HCP Consul cluster.

    Example Usage

    using System.Collections.Generic;
    using Pulumi;
    using Hcp = Pulumi.Hcp;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleHvn = new Hcp.Hvn("exampleHvn", new()
        {
            HvnId = "hvn",
            CloudProvider = "aws",
            Region = "us-west-2",
            CidrBlock = "172.25.16.0/20",
        });
    
        var exampleConsulCluster = new Hcp.ConsulCluster("exampleConsulCluster", new()
        {
            ClusterId = "consul-cluster",
            HvnId = exampleHvn.HvnId,
            Tier = "development",
        });
    
    });
    
    package main
    
    import (
    	"github.com/grapl-security/pulumi-hcp/sdk/go/hcp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		exampleHvn, err := hcp.NewHvn(ctx, "exampleHvn", &hcp.HvnArgs{
    			HvnId:         pulumi.String("hvn"),
    			CloudProvider: pulumi.String("aws"),
    			Region:        pulumi.String("us-west-2"),
    			CidrBlock:     pulumi.String("172.25.16.0/20"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = hcp.NewConsulCluster(ctx, "exampleConsulCluster", &hcp.ConsulClusterArgs{
    			ClusterId: pulumi.String("consul-cluster"),
    			HvnId:     exampleHvn.HvnId,
    			Tier:      pulumi.String("development"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hcp.Hvn;
    import com.pulumi.hcp.HvnArgs;
    import com.pulumi.hcp.ConsulCluster;
    import com.pulumi.hcp.ConsulClusterArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var exampleHvn = new Hvn("exampleHvn", HvnArgs.builder()        
                .hvnId("hvn")
                .cloudProvider("aws")
                .region("us-west-2")
                .cidrBlock("172.25.16.0/20")
                .build());
    
            var exampleConsulCluster = new ConsulCluster("exampleConsulCluster", ConsulClusterArgs.builder()        
                .clusterId("consul-cluster")
                .hvnId(exampleHvn.hvnId())
                .tier("development")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_hcp as hcp
    
    example_hvn = hcp.Hvn("exampleHvn",
        hvn_id="hvn",
        cloud_provider="aws",
        region="us-west-2",
        cidr_block="172.25.16.0/20")
    example_consul_cluster = hcp.ConsulCluster("exampleConsulCluster",
        cluster_id="consul-cluster",
        hvn_id=example_hvn.hvn_id,
        tier="development")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as hcp from "@grapl/pulumi-hcp";
    
    const exampleHvn = new hcp.Hvn("exampleHvn", {
        hvnId: "hvn",
        cloudProvider: "aws",
        region: "us-west-2",
        cidrBlock: "172.25.16.0/20",
    });
    const exampleConsulCluster = new hcp.ConsulCluster("exampleConsulCluster", {
        clusterId: "consul-cluster",
        hvnId: exampleHvn.hvnId,
        tier: "development",
    });
    
    resources:
      exampleHvn:
        type: hcp:Hvn
        properties:
          hvnId: hvn
          cloudProvider: aws
          region: us-west-2
          cidrBlock: 172.25.16.0/20
      exampleConsulCluster:
        type: hcp:ConsulCluster
        properties:
          clusterId: consul-cluster
          hvnId: ${exampleHvn.hvnId}
          tier: development
    

    Create ConsulCluster Resource

    new ConsulCluster(name: string, args: ConsulClusterArgs, opts?: CustomResourceOptions);
    @overload
    def ConsulCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      auto_hvn_to_hvn_peering: Optional[bool] = None,
                      cluster_id: Optional[str] = None,
                      connect_enabled: Optional[bool] = None,
                      datacenter: Optional[str] = None,
                      hvn_id: Optional[str] = None,
                      min_consul_version: Optional[str] = None,
                      primary_link: Optional[str] = None,
                      public_endpoint: Optional[bool] = None,
                      size: Optional[str] = None,
                      tier: Optional[str] = None)
    @overload
    def ConsulCluster(resource_name: str,
                      args: ConsulClusterArgs,
                      opts: Optional[ResourceOptions] = None)
    func NewConsulCluster(ctx *Context, name string, args ConsulClusterArgs, opts ...ResourceOption) (*ConsulCluster, error)
    public ConsulCluster(string name, ConsulClusterArgs args, CustomResourceOptions? opts = null)
    public ConsulCluster(String name, ConsulClusterArgs args)
    public ConsulCluster(String name, ConsulClusterArgs args, CustomResourceOptions options)
    
    type: hcp:ConsulCluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ConsulClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConsulClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConsulClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsulClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsulClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ConsulCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConsulCluster resource accepts the following input properties:

    ClusterId string
    The ID of the HCP Consul cluster.
    HvnId string
    The ID of the HVN this HCP Consul cluster is associated to.
    Tier string
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    AutoHvnToHvnPeering bool
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    ConnectEnabled bool
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    Datacenter string
    The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
    MinConsulVersion string
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    PrimaryLink 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.
    PublicEndpoint bool
    Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
    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/consul. Upgrading the size of a cluster after creation is allowed.
    ClusterId string
    The ID of the HCP Consul cluster.
    HvnId string
    The ID of the HVN this HCP Consul cluster is associated to.
    Tier string
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    AutoHvnToHvnPeering bool
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    ConnectEnabled bool
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    Datacenter string
    The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
    MinConsulVersion string
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    PrimaryLink 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.
    PublicEndpoint bool
    Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
    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/consul. Upgrading the size of a cluster after creation is allowed.
    clusterId String
    The ID of the HCP Consul cluster.
    hvnId String
    The ID of the HVN this HCP Consul cluster is associated to.
    tier String
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    autoHvnToHvnPeering Boolean
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    connectEnabled Boolean
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    datacenter String
    The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
    minConsulVersion String
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    primaryLink 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.
    publicEndpoint Boolean
    Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
    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/consul. Upgrading the size of a cluster after creation is allowed.
    clusterId string
    The ID of the HCP Consul cluster.
    hvnId string
    The ID of the HVN this HCP Consul cluster is associated to.
    tier string
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    autoHvnToHvnPeering boolean
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    connectEnabled boolean
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    datacenter string
    The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
    minConsulVersion string
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    primaryLink 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.
    publicEndpoint boolean
    Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
    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/consul. Upgrading the size of a cluster after creation is allowed.
    cluster_id str
    The ID of the HCP Consul cluster.
    hvn_id str
    The ID of the HVN this HCP Consul cluster is associated to.
    tier str
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    auto_hvn_to_hvn_peering bool
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    connect_enabled bool
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    datacenter str
    The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
    min_consul_version str
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    primary_link str
    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 bool
    Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
    size str
    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/consul. Upgrading the size of a cluster after creation is allowed.
    clusterId String
    The ID of the HCP Consul cluster.
    hvnId String
    The ID of the HVN this HCP Consul cluster is associated to.
    tier String
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    autoHvnToHvnPeering Boolean
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    connectEnabled Boolean
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    datacenter String
    The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
    minConsulVersion String
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    primaryLink 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.
    publicEndpoint Boolean
    Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
    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/consul. Upgrading the size of a cluster after creation is allowed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConsulCluster resource produces the following output properties:

    CloudProvider string
    The provider where the HCP Consul cluster is located.
    ConsulAutomaticUpgrades bool
    Denotes that automatic Consul upgrades are enabled.
    ConsulCaFile string
    The cluster CA file encoded as a Base64 string.
    ConsulConfigFile string
    The cluster config encoded as a Base64 string.
    ConsulPrivateEndpointUrl string
    The private URL for the Consul UI.
    ConsulPublicEndpointUrl string
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    ConsulRootTokenAccessorId string
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulRootTokenSecretId string
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulSnapshotInterval string
    The Consul snapshot interval.
    ConsulSnapshotRetention string
    The retention policy for Consul snapshots.
    ConsulVersion string
    The Consul version of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The ID of the organization this HCP Consul cluster is located in.
    ProjectId string
    The ID of the project this HCP Consul cluster is located in.
    Region string
    The region where the HCP Consul cluster is located.
    Scale int
    The number of Consul server nodes in the cluster.
    SelfLink string
    A unique URL identifying the HCP Consul cluster.
    State string
    The state of the HCP Consul cluster.
    CloudProvider string
    The provider where the HCP Consul cluster is located.
    ConsulAutomaticUpgrades bool
    Denotes that automatic Consul upgrades are enabled.
    ConsulCaFile string
    The cluster CA file encoded as a Base64 string.
    ConsulConfigFile string
    The cluster config encoded as a Base64 string.
    ConsulPrivateEndpointUrl string
    The private URL for the Consul UI.
    ConsulPublicEndpointUrl string
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    ConsulRootTokenAccessorId string
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulRootTokenSecretId string
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulSnapshotInterval string
    The Consul snapshot interval.
    ConsulSnapshotRetention string
    The retention policy for Consul snapshots.
    ConsulVersion string
    The Consul version of the cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    OrganizationId string
    The ID of the organization this HCP Consul cluster is located in.
    ProjectId string
    The ID of the project this HCP Consul cluster is located in.
    Region string
    The region where the HCP Consul cluster is located.
    Scale int
    The number of Consul server nodes in the cluster.
    SelfLink string
    A unique URL identifying the HCP Consul cluster.
    State string
    The state of the HCP Consul cluster.
    cloudProvider String
    The provider where the HCP Consul cluster is located.
    consulAutomaticUpgrades Boolean
    Denotes that automatic Consul upgrades are enabled.
    consulCaFile String
    The cluster CA file encoded as a Base64 string.
    consulConfigFile String
    The cluster config encoded as a Base64 string.
    consulPrivateEndpointUrl String
    The private URL for the Consul UI.
    consulPublicEndpointUrl String
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consulRootTokenAccessorId String
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulRootTokenSecretId String
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulSnapshotInterval String
    The Consul snapshot interval.
    consulSnapshotRetention String
    The retention policy for Consul snapshots.
    consulVersion String
    The Consul version of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The ID of the organization this HCP Consul cluster is located in.
    projectId String
    The ID of the project this HCP Consul cluster is located in.
    region String
    The region where the HCP Consul cluster is located.
    scale Integer
    The number of Consul server nodes in the cluster.
    selfLink String
    A unique URL identifying the HCP Consul cluster.
    state String
    The state of the HCP Consul cluster.
    cloudProvider string
    The provider where the HCP Consul cluster is located.
    consulAutomaticUpgrades boolean
    Denotes that automatic Consul upgrades are enabled.
    consulCaFile string
    The cluster CA file encoded as a Base64 string.
    consulConfigFile string
    The cluster config encoded as a Base64 string.
    consulPrivateEndpointUrl string
    The private URL for the Consul UI.
    consulPublicEndpointUrl string
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consulRootTokenAccessorId string
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulRootTokenSecretId string
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulSnapshotInterval string
    The Consul snapshot interval.
    consulSnapshotRetention string
    The retention policy for Consul snapshots.
    consulVersion string
    The Consul version of the cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    organizationId string
    The ID of the organization this HCP Consul cluster is located in.
    projectId string
    The ID of the project this HCP Consul cluster is located in.
    region string
    The region where the HCP Consul cluster is located.
    scale number
    The number of Consul server nodes in the cluster.
    selfLink string
    A unique URL identifying the HCP Consul cluster.
    state string
    The state of the HCP Consul cluster.
    cloud_provider str
    The provider where the HCP Consul cluster is located.
    consul_automatic_upgrades bool
    Denotes that automatic Consul upgrades are enabled.
    consul_ca_file str
    The cluster CA file encoded as a Base64 string.
    consul_config_file str
    The cluster config encoded as a Base64 string.
    consul_private_endpoint_url str
    The private URL for the Consul UI.
    consul_public_endpoint_url str
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consul_root_token_accessor_id str
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consul_root_token_secret_id str
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consul_snapshot_interval str
    The Consul snapshot interval.
    consul_snapshot_retention str
    The retention policy for Consul snapshots.
    consul_version str
    The Consul version of the cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    organization_id str
    The ID of the organization this HCP Consul cluster is located in.
    project_id str
    The ID of the project this HCP Consul cluster is located in.
    region str
    The region where the HCP Consul cluster is located.
    scale int
    The number of Consul server nodes in the cluster.
    self_link str
    A unique URL identifying the HCP Consul cluster.
    state str
    The state of the HCP Consul cluster.
    cloudProvider String
    The provider where the HCP Consul cluster is located.
    consulAutomaticUpgrades Boolean
    Denotes that automatic Consul upgrades are enabled.
    consulCaFile String
    The cluster CA file encoded as a Base64 string.
    consulConfigFile String
    The cluster config encoded as a Base64 string.
    consulPrivateEndpointUrl String
    The private URL for the Consul UI.
    consulPublicEndpointUrl String
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consulRootTokenAccessorId String
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulRootTokenSecretId String
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulSnapshotInterval String
    The Consul snapshot interval.
    consulSnapshotRetention String
    The retention policy for Consul snapshots.
    consulVersion String
    The Consul version of the cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    organizationId String
    The ID of the organization this HCP Consul cluster is located in.
    projectId String
    The ID of the project this HCP Consul cluster is located in.
    region String
    The region where the HCP Consul cluster is located.
    scale Number
    The number of Consul server nodes in the cluster.
    selfLink String
    A unique URL identifying the HCP Consul cluster.
    state String
    The state of the HCP Consul cluster.

    Look up Existing ConsulCluster Resource

    Get an existing ConsulCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConsulClusterState, opts?: CustomResourceOptions): ConsulCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            auto_hvn_to_hvn_peering: Optional[bool] = None,
            cloud_provider: Optional[str] = None,
            cluster_id: Optional[str] = None,
            connect_enabled: Optional[bool] = None,
            consul_automatic_upgrades: Optional[bool] = None,
            consul_ca_file: Optional[str] = None,
            consul_config_file: Optional[str] = None,
            consul_private_endpoint_url: Optional[str] = None,
            consul_public_endpoint_url: Optional[str] = None,
            consul_root_token_accessor_id: Optional[str] = None,
            consul_root_token_secret_id: Optional[str] = None,
            consul_snapshot_interval: Optional[str] = None,
            consul_snapshot_retention: Optional[str] = None,
            consul_version: Optional[str] = None,
            datacenter: Optional[str] = None,
            hvn_id: Optional[str] = None,
            min_consul_version: Optional[str] = None,
            organization_id: Optional[str] = None,
            primary_link: Optional[str] = None,
            project_id: Optional[str] = None,
            public_endpoint: Optional[bool] = None,
            region: Optional[str] = None,
            scale: Optional[int] = None,
            self_link: Optional[str] = None,
            size: Optional[str] = None,
            state: Optional[str] = None,
            tier: Optional[str] = None) -> ConsulCluster
    func GetConsulCluster(ctx *Context, name string, id IDInput, state *ConsulClusterState, opts ...ResourceOption) (*ConsulCluster, error)
    public static ConsulCluster Get(string name, Input<string> id, ConsulClusterState? state, CustomResourceOptions? opts = null)
    public static ConsulCluster get(String name, Output<String> id, ConsulClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AutoHvnToHvnPeering bool
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    CloudProvider string
    The provider where the HCP Consul cluster is located.
    ClusterId string
    The ID of the HCP Consul cluster.
    ConnectEnabled bool
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    ConsulAutomaticUpgrades bool
    Denotes that automatic Consul upgrades are enabled.
    ConsulCaFile string
    The cluster CA file encoded as a Base64 string.
    ConsulConfigFile string
    The cluster config encoded as a Base64 string.
    ConsulPrivateEndpointUrl string
    The private URL for the Consul UI.
    ConsulPublicEndpointUrl string
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    ConsulRootTokenAccessorId string
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulRootTokenSecretId string
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulSnapshotInterval string
    The Consul snapshot interval.
    ConsulSnapshotRetention string
    The retention policy for Consul snapshots.
    ConsulVersion 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.
    HvnId string
    The ID of the HVN this HCP Consul cluster is associated to.
    MinConsulVersion string
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    OrganizationId string
    The ID of the organization this HCP Consul cluster is located in.
    PrimaryLink 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.
    ProjectId string
    The ID of the project this HCP Consul cluster is located in.
    PublicEndpoint bool
    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 int
    The number of Consul server nodes in the cluster.
    SelfLink 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/consul. Upgrading the size of a cluster after creation is allowed.
    State string
    The state of the HCP Consul cluster.
    Tier string
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    AutoHvnToHvnPeering bool
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    CloudProvider string
    The provider where the HCP Consul cluster is located.
    ClusterId string
    The ID of the HCP Consul cluster.
    ConnectEnabled bool
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    ConsulAutomaticUpgrades bool
    Denotes that automatic Consul upgrades are enabled.
    ConsulCaFile string
    The cluster CA file encoded as a Base64 string.
    ConsulConfigFile string
    The cluster config encoded as a Base64 string.
    ConsulPrivateEndpointUrl string
    The private URL for the Consul UI.
    ConsulPublicEndpointUrl string
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    ConsulRootTokenAccessorId string
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulRootTokenSecretId string
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    ConsulSnapshotInterval string
    The Consul snapshot interval.
    ConsulSnapshotRetention string
    The retention policy for Consul snapshots.
    ConsulVersion 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.
    HvnId string
    The ID of the HVN this HCP Consul cluster is associated to.
    MinConsulVersion string
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    OrganizationId string
    The ID of the organization this HCP Consul cluster is located in.
    PrimaryLink 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.
    ProjectId string
    The ID of the project this HCP Consul cluster is located in.
    PublicEndpoint bool
    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 int
    The number of Consul server nodes in the cluster.
    SelfLink 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/consul. Upgrading the size of a cluster after creation is allowed.
    State string
    The state of the HCP Consul cluster.
    Tier string
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    autoHvnToHvnPeering Boolean
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    cloudProvider String
    The provider where the HCP Consul cluster is located.
    clusterId String
    The ID of the HCP Consul cluster.
    connectEnabled Boolean
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    consulAutomaticUpgrades Boolean
    Denotes that automatic Consul upgrades are enabled.
    consulCaFile String
    The cluster CA file encoded as a Base64 string.
    consulConfigFile String
    The cluster config encoded as a Base64 string.
    consulPrivateEndpointUrl String
    The private URL for the Consul UI.
    consulPublicEndpointUrl String
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consulRootTokenAccessorId String
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulRootTokenSecretId String
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulSnapshotInterval String
    The Consul snapshot interval.
    consulSnapshotRetention String
    The retention policy for Consul snapshots.
    consulVersion 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.
    hvnId String
    The ID of the HVN this HCP Consul cluster is associated to.
    minConsulVersion String
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    organizationId String
    The ID of the organization this HCP Consul cluster is located in.
    primaryLink 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.
    projectId String
    The ID of the project this HCP Consul cluster is located in.
    publicEndpoint 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 Integer
    The number of Consul server nodes in the cluster.
    selfLink 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/consul. Upgrading the size of a cluster after creation is allowed.
    state String
    The state of the HCP Consul cluster.
    tier String
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    autoHvnToHvnPeering boolean
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    cloudProvider string
    The provider where the HCP Consul cluster is located.
    clusterId string
    The ID of the HCP Consul cluster.
    connectEnabled boolean
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    consulAutomaticUpgrades boolean
    Denotes that automatic Consul upgrades are enabled.
    consulCaFile string
    The cluster CA file encoded as a Base64 string.
    consulConfigFile string
    The cluster config encoded as a Base64 string.
    consulPrivateEndpointUrl string
    The private URL for the Consul UI.
    consulPublicEndpointUrl string
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consulRootTokenAccessorId string
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulRootTokenSecretId string
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulSnapshotInterval string
    The Consul snapshot interval.
    consulSnapshotRetention string
    The retention policy for Consul snapshots.
    consulVersion 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.
    hvnId string
    The ID of the HVN this HCP Consul cluster is associated to.
    minConsulVersion string
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    organizationId string
    The ID of the organization this HCP Consul cluster is located in.
    primaryLink 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.
    projectId string
    The ID of the project this HCP Consul cluster is located in.
    publicEndpoint 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 number of Consul server nodes in the cluster.
    selfLink 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/consul. Upgrading the size of a cluster after creation is allowed.
    state string
    The state of the HCP Consul cluster.
    tier string
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    auto_hvn_to_hvn_peering bool
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    cloud_provider str
    The provider where the HCP Consul cluster is located.
    cluster_id str
    The ID of the HCP Consul cluster.
    connect_enabled bool
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    consul_automatic_upgrades bool
    Denotes that automatic Consul upgrades are enabled.
    consul_ca_file str
    The cluster CA file encoded as a Base64 string.
    consul_config_file str
    The cluster config encoded as a Base64 string.
    consul_private_endpoint_url str
    The private URL for the Consul UI.
    consul_public_endpoint_url str
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consul_root_token_accessor_id str
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consul_root_token_secret_id str
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consul_snapshot_interval str
    The Consul snapshot interval.
    consul_snapshot_retention str
    The retention policy for Consul snapshots.
    consul_version str
    The Consul version of the cluster.
    datacenter str
    The Consul data center name of the cluster. If not specified, it is defaulted to the value of cluster_id.
    hvn_id str
    The ID of the HVN this HCP Consul cluster is associated to.
    min_consul_version str
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    organization_id str
    The ID of the organization this HCP Consul cluster is located in.
    primary_link str
    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.
    project_id str
    The ID of the project this HCP Consul cluster is located in.
    public_endpoint bool
    Denotes that the cluster has a public endpoint for the Consul UI. Defaults to false.
    region str
    The region where the HCP Consul cluster is located.
    scale int
    The number of Consul server nodes in the cluster.
    self_link str
    A unique URL identifying the HCP Consul cluster.
    size str
    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/consul. Upgrading the size of a cluster after creation is allowed.
    state str
    The state of the HCP Consul cluster.
    tier str
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.
    autoHvnToHvnPeering Boolean
    Enables automatic HVN to HVN peering when creating a secondary cluster in a federation. The alternative to using the auto-accept feature is to create an hcp.HvnPeeringConnection resource that explicitly defines the HVN resources that are allowed to communicate with each other.
    cloudProvider String
    The provider where the HCP Consul cluster is located.
    clusterId String
    The ID of the HCP Consul cluster.
    connectEnabled Boolean
    Denotes the Consul connect feature should be enabled for this cluster. Default to true.
    consulAutomaticUpgrades Boolean
    Denotes that automatic Consul upgrades are enabled.
    consulCaFile String
    The cluster CA file encoded as a Base64 string.
    consulConfigFile String
    The cluster config encoded as a Base64 string.
    consulPrivateEndpointUrl String
    The private URL for the Consul UI.
    consulPublicEndpointUrl String
    The public URL for the Consul UI. This will be empty if public_endpoint is false.
    consulRootTokenAccessorId String
    The accessor ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulRootTokenSecretId String
    The secret ID of the root ACL token that is generated upon cluster creation. If a new root token is generated using the hcp_consul_root_token resource, this field is no longer valid.
    consulSnapshotInterval String
    The Consul snapshot interval.
    consulSnapshotRetention String
    The retention policy for Consul snapshots.
    consulVersion 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.
    hvnId String
    The ID of the HVN this HCP Consul cluster is associated to.
    minConsulVersion String
    The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
    organizationId String
    The ID of the organization this HCP Consul cluster is located in.
    primaryLink 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.
    projectId String
    The ID of the project this HCP Consul cluster is located in.
    publicEndpoint 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 number of Consul server nodes in the cluster.
    selfLink 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/consul. Upgrading the size of a cluster after creation is allowed.
    state String
    The state of the HCP Consul cluster.
    tier String
    The tier that the HCP Consul cluster will be provisioned as. Only development, standard and plus are available at this time. See pricing information.

    Import

    The import ID is {cluster_id}

     $ pulumi import hcp:index/consulCluster:ConsulCluster example consul-cluster
    

    Package Details

    Repository
    hcp grapl-security/pulumi-hcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the hcp Terraform Provider.
    hcp logo
    HashiCorp Cloud Platform (HCP) v0.1.14 published on Friday, Dec 2, 2022 by Grapl Security