hcp.ConsulCluster
Explore with Pulumi AI
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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ConsulCluster(name: string, args: ConsulClusterArgs, opts?: CustomResourceOptions);
@overload
def ConsulCluster(resource_name: str,
args: ConsulClusterArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ConsulCluster(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_id: Optional[str] = None,
hvn_id: Optional[str] = None,
tier: Optional[str] = None,
auto_hvn_to_hvn_peering: Optional[bool] = None,
connect_enabled: Optional[bool] = None,
datacenter: Optional[str] = None,
min_consul_version: Optional[str] = None,
primary_link: Optional[str] = None,
public_endpoint: Optional[bool] = None,
size: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var consulClusterResource = new Hcp.ConsulCluster("consulClusterResource", new()
{
ClusterId = "string",
HvnId = "string",
Tier = "string",
AutoHvnToHvnPeering = false,
ConnectEnabled = false,
Datacenter = "string",
MinConsulVersion = "string",
PrimaryLink = "string",
PublicEndpoint = false,
Size = "string",
});
example, err := hcp.NewConsulCluster(ctx, "consulClusterResource", &hcp.ConsulClusterArgs{
ClusterId: pulumi.String("string"),
HvnId: pulumi.String("string"),
Tier: pulumi.String("string"),
AutoHvnToHvnPeering: pulumi.Bool(false),
ConnectEnabled: pulumi.Bool(false),
Datacenter: pulumi.String("string"),
MinConsulVersion: pulumi.String("string"),
PrimaryLink: pulumi.String("string"),
PublicEndpoint: pulumi.Bool(false),
Size: pulumi.String("string"),
})
var consulClusterResource = new ConsulCluster("consulClusterResource", ConsulClusterArgs.builder()
.clusterId("string")
.hvnId("string")
.tier("string")
.autoHvnToHvnPeering(false)
.connectEnabled(false)
.datacenter("string")
.minConsulVersion("string")
.primaryLink("string")
.publicEndpoint(false)
.size("string")
.build());
consul_cluster_resource = hcp.ConsulCluster("consulClusterResource",
cluster_id="string",
hvn_id="string",
tier="string",
auto_hvn_to_hvn_peering=False,
connect_enabled=False,
datacenter="string",
min_consul_version="string",
primary_link="string",
public_endpoint=False,
size="string")
const consulClusterResource = new hcp.ConsulCluster("consulClusterResource", {
clusterId: "string",
hvnId: "string",
tier: "string",
autoHvnToHvnPeering: false,
connectEnabled: false,
datacenter: "string",
minConsulVersion: "string",
primaryLink: "string",
publicEndpoint: false,
size: "string",
});
type: hcp:ConsulCluster
properties:
autoHvnToHvnPeering: false
clusterId: string
connectEnabled: false
datacenter: string
hvnId: string
minConsulVersion: string
primaryLink: string
publicEndpoint: false
size: string
tier: string
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:
- Cluster
Id string - The ID of the HCP Consul cluster.
- Hvn
Id 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
andplus
are available at this time. See pricing information. - Auto
Hvn boolTo Hvn Peering - 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 string
- The Consul data center name of the cluster. If not specified, it is defaulted to the value of
cluster_id
. - Min
Consul stringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- 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 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.
- Cluster
Id string - The ID of the HCP Consul cluster.
- Hvn
Id 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
andplus
are available at this time. See pricing information. - Auto
Hvn boolTo Hvn Peering - 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 string
- The Consul data center name of the cluster. If not specified, it is defaulted to the value of
cluster_id
. - Min
Consul stringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- 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 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.
- cluster
Id String - The ID of the HCP Consul cluster.
- hvn
Id 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
andplus
are available at this time. See pricing information. - auto
Hvn BooleanTo Hvn Peering - 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 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
. - min
Consul StringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- 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.
- 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 string - The ID of the HCP Consul cluster.
- hvn
Id 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
andplus
are available at this time. See pricing information. - auto
Hvn booleanTo Hvn Peering - 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 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
. - min
Consul stringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- 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.
- 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
andplus
are available at this time. See pricing information. - auto_
hvn_ boolto_ hvn_ peering - 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_ strversion - 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.
- cluster
Id String - The ID of the HCP Consul cluster.
- hvn
Id 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
andplus
are available at this time. See pricing information. - auto
Hvn BooleanTo Hvn Peering - 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 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
. - min
Consul StringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- 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.
- 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:
- Cloud
Provider string - The provider where the HCP Consul cluster is located.
- Consul
Automatic boolUpgrades - Denotes that automatic Consul upgrades are enabled.
- Consul
Ca stringFile - The cluster CA file encoded as a Base64 string.
- Consul
Config stringFile - The cluster config encoded as a Base64 string.
- Consul
Private stringEndpoint Url - The private URL for the Consul UI.
- Consul
Public stringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - Consul
Root stringToken Accessor Id - 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 stringToken Secret Id - 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 stringInterval - The Consul snapshot interval.
- Consul
Snapshot stringRetention - The retention policy for Consul snapshots.
- Consul
Version string - The Consul version of the cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The ID of the organization this HCP Consul cluster is located in.
- Project
Id 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.
- Self
Link string - A unique URL identifying the HCP Consul cluster.
- State string
- The state of the HCP Consul cluster.
- Cloud
Provider string - The provider where the HCP Consul cluster is located.
- Consul
Automatic boolUpgrades - Denotes that automatic Consul upgrades are enabled.
- Consul
Ca stringFile - The cluster CA file encoded as a Base64 string.
- Consul
Config stringFile - The cluster config encoded as a Base64 string.
- Consul
Private stringEndpoint Url - The private URL for the Consul UI.
- Consul
Public stringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - Consul
Root stringToken Accessor Id - 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 stringToken Secret Id - 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 stringInterval - The Consul snapshot interval.
- Consul
Snapshot stringRetention - The retention policy for Consul snapshots.
- Consul
Version string - The Consul version of the cluster.
- Id string
- The provider-assigned unique ID for this managed resource.
- Organization
Id string - The ID of the organization this HCP Consul cluster is located in.
- Project
Id 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.
- Self
Link string - A unique URL identifying the HCP Consul cluster.
- State string
- The state of the HCP Consul cluster.
- cloud
Provider String - The provider where the HCP Consul cluster is located.
- consul
Automatic BooleanUpgrades - Denotes that automatic Consul upgrades are enabled.
- consul
Ca StringFile - The cluster CA file encoded as a Base64 string.
- consul
Config StringFile - The cluster config encoded as a Base64 string.
- consul
Private StringEndpoint Url - The private URL for the Consul UI.
- consul
Public StringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul
Root StringToken Accessor Id - 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 StringToken Secret Id - 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 StringInterval - The Consul snapshot interval.
- consul
Snapshot StringRetention - The retention policy for Consul snapshots.
- consul
Version String - The Consul version of the cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The ID of the organization this HCP Consul cluster is located in.
- project
Id 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.
- self
Link String - A unique URL identifying the HCP Consul cluster.
- state String
- The state of the HCP Consul cluster.
- cloud
Provider string - The provider where the HCP Consul cluster is located.
- consul
Automatic booleanUpgrades - Denotes that automatic Consul upgrades are enabled.
- consul
Ca stringFile - The cluster CA file encoded as a Base64 string.
- consul
Config stringFile - The cluster config encoded as a Base64 string.
- consul
Private stringEndpoint Url - The private URL for the Consul UI.
- consul
Public stringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul
Root stringToken Accessor Id - 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 stringToken Secret Id - 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 stringInterval - The Consul snapshot interval.
- consul
Snapshot stringRetention - The retention policy for Consul snapshots.
- consul
Version string - The Consul version of the cluster.
- id string
- The provider-assigned unique ID for this managed resource.
- organization
Id string - The ID of the organization this HCP Consul cluster is located in.
- project
Id 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.
- self
Link 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_ boolupgrades - Denotes that automatic Consul upgrades are enabled.
- consul_
ca_ strfile - The cluster CA file encoded as a Base64 string.
- consul_
config_ strfile - The cluster config encoded as a Base64 string.
- consul_
private_ strendpoint_ url - The private URL for the Consul UI.
- consul_
public_ strendpoint_ url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul_
root_ strtoken_ accessor_ id - 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_ strtoken_ secret_ id - 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_ strinterval - The Consul snapshot interval.
- consul_
snapshot_ strretention - 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.
- cloud
Provider String - The provider where the HCP Consul cluster is located.
- consul
Automatic BooleanUpgrades - Denotes that automatic Consul upgrades are enabled.
- consul
Ca StringFile - The cluster CA file encoded as a Base64 string.
- consul
Config StringFile - The cluster config encoded as a Base64 string.
- consul
Private StringEndpoint Url - The private URL for the Consul UI.
- consul
Public StringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul
Root StringToken Accessor Id - 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 StringToken Secret Id - 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 StringInterval - The Consul snapshot interval.
- consul
Snapshot StringRetention - The retention policy for Consul snapshots.
- consul
Version String - The Consul version of the cluster.
- id String
- The provider-assigned unique ID for this managed resource.
- organization
Id String - The ID of the organization this HCP Consul cluster is located in.
- project
Id 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.
- self
Link 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.
- Auto
Hvn boolTo Hvn Peering - 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 string - The provider where the HCP Consul cluster is located.
- Cluster
Id string - 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 boolUpgrades - Denotes that automatic Consul upgrades are enabled.
- Consul
Ca stringFile - The cluster CA file encoded as a Base64 string.
- Consul
Config stringFile - The cluster config encoded as a Base64 string.
- Consul
Private stringEndpoint Url - The private URL for the Consul UI.
- Consul
Public stringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - Consul
Root stringToken Accessor Id - 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 stringToken Secret Id - 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 stringInterval - The Consul snapshot interval.
- Consul
Snapshot stringRetention - 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.
- Min
Consul stringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- Organization
Id string - The ID of the organization this HCP Consul cluster is located in.
- 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. - Project
Id string - 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 string
- The region where the HCP Consul cluster is located.
- Scale int
- 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/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
andplus
are available at this time. See pricing information.
- Auto
Hvn boolTo Hvn Peering - 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 string - The provider where the HCP Consul cluster is located.
- Cluster
Id string - 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 boolUpgrades - Denotes that automatic Consul upgrades are enabled.
- Consul
Ca stringFile - The cluster CA file encoded as a Base64 string.
- Consul
Config stringFile - The cluster config encoded as a Base64 string.
- Consul
Private stringEndpoint Url - The private URL for the Consul UI.
- Consul
Public stringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - Consul
Root stringToken Accessor Id - 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 stringToken Secret Id - 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 stringInterval - The Consul snapshot interval.
- Consul
Snapshot stringRetention - 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.
- Min
Consul stringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- Organization
Id string - The ID of the organization this HCP Consul cluster is located in.
- 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. - Project
Id string - 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 string
- The region where the HCP Consul cluster is located.
- Scale int
- 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/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
andplus
are available at this time. See pricing information.
- auto
Hvn BooleanTo Hvn Peering - 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 String - The provider where the HCP Consul cluster is located.
- cluster
Id String - The ID of the HCP Consul cluster.
- connect
Enabled Boolean - Denotes the Consul connect feature should be enabled for this cluster. Default to true.
- consul
Automatic BooleanUpgrades - Denotes that automatic Consul upgrades are enabled.
- consul
Ca StringFile - The cluster CA file encoded as a Base64 string.
- consul
Config StringFile - The cluster config encoded as a Base64 string.
- consul
Private StringEndpoint Url - The private URL for the Consul UI.
- consul
Public StringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul
Root StringToken Accessor Id - 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 StringToken Secret Id - 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 StringInterval - The Consul snapshot interval.
- consul
Snapshot StringRetention - 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.
- min
Consul StringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- organization
Id String - The ID of the organization this HCP Consul cluster is located in.
- 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. - project
Id String - The ID of the project this HCP Consul cluster is located in.
- 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 Integer
- 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/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
andplus
are available at this time. See pricing information.
- auto
Hvn booleanTo Hvn Peering - 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 string - The provider where the HCP Consul cluster is located.
- cluster
Id string - The ID of the HCP Consul cluster.
- connect
Enabled boolean - Denotes the Consul connect feature should be enabled for this cluster. Default to true.
- consul
Automatic booleanUpgrades - Denotes that automatic Consul upgrades are enabled.
- consul
Ca stringFile - The cluster CA file encoded as a Base64 string.
- consul
Config stringFile - The cluster config encoded as a Base64 string.
- consul
Private stringEndpoint Url - The private URL for the Consul UI.
- consul
Public stringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul
Root stringToken Accessor Id - 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 stringToken Secret Id - 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 stringInterval - The Consul snapshot interval.
- consul
Snapshot stringRetention - 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.
- min
Consul stringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- organization
Id string - The ID of the organization this HCP Consul cluster is located in.
- 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. - project
Id string - The ID of the project this HCP Consul cluster is located in.
- 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 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/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
andplus
are available at this time. See pricing information.
- auto_
hvn_ boolto_ hvn_ peering - 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_ boolupgrades - Denotes that automatic Consul upgrades are enabled.
- consul_
ca_ strfile - The cluster CA file encoded as a Base64 string.
- consul_
config_ strfile - The cluster config encoded as a Base64 string.
- consul_
private_ strendpoint_ url - The private URL for the Consul UI.
- consul_
public_ strendpoint_ url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul_
root_ strtoken_ accessor_ id - 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_ strtoken_ secret_ id - 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_ strinterval - The Consul snapshot interval.
- consul_
snapshot_ strretention - 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_ strversion - 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
andplus
are available at this time. See pricing information.
- auto
Hvn BooleanTo Hvn Peering - 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 String - The provider where the HCP Consul cluster is located.
- cluster
Id String - The ID of the HCP Consul cluster.
- connect
Enabled Boolean - Denotes the Consul connect feature should be enabled for this cluster. Default to true.
- consul
Automatic BooleanUpgrades - Denotes that automatic Consul upgrades are enabled.
- consul
Ca StringFile - The cluster CA file encoded as a Base64 string.
- consul
Config StringFile - The cluster config encoded as a Base64 string.
- consul
Private StringEndpoint Url - The private URL for the Consul UI.
- consul
Public StringEndpoint Url - The public URL for the Consul UI. This will be empty if
public_endpoint
isfalse
. - consul
Root StringToken Accessor Id - 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 StringToken Secret Id - 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 StringInterval - The Consul snapshot interval.
- consul
Snapshot StringRetention - 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.
- min
Consul StringVersion - The minimum Consul version of the cluster. If not specified, it is defaulted to the version that is currently recommended by HCP.
- organization
Id String - The ID of the organization this HCP Consul cluster is located in.
- 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. - project
Id String - The ID of the project this HCP Consul cluster is located in.
- 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 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/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
andplus
are available at this time. See pricing information.
Import
The import ID is {cluster_id}
$ pulumi import hcp:index/consulCluster:ConsulCluster example consul-cluster
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- hcp grapl-security/pulumi-hcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
hcp
Terraform Provider.