cluster.typescript.md

cluster Submodule

Constructs

Cluster

Represents a {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster hcs_cluster}.

Initializers

import { cluster } from '@cdktf/provider-hcs'

new cluster.Cluster(scope: Construct, id: string, config: ClusterConfig)

Name	Type	Description
scope	constructs.Construct	The scope in which to define this construct.
id	string	The scoped construct ID.
config	ClusterConfig	No description.

---

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

id^Required

• Type: string

The scoped construct ID.

Must be unique amongst siblings in the same scope

---

config^Required

• Type: ClusterConfig

---

Methods

Name	Description
toString	Returns a string representation of this construct.
addOverride	No description.
overrideLogicalId	Overrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalId	Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform	No description.
toMetadata	No description.
toTerraform	Adds this resource to the terraform JSON output.
addMoveTarget	Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
hasResourceMove	No description.
importFrom	No description.
interpolationForAttribute	No description.
moveFromId	Move the resource corresponding to "id" to this resource.
moveTo	Moves this resource to the target resource given by moveTarget.
moveToId	Moves this resource to the resource corresponding to "id".
putTimeouts	No description.
resetAuditLoggingEnabled	No description.
resetAuditLogStorageContainerUrl	No description.
resetClusterName	No description.
resetConsulDatacenter	No description.
resetConsulExternalEndpoint	No description.
resetConsulFederationToken	No description.
resetId	No description.
resetLocation	No description.
resetManagedResourceGroupName	No description.
resetMinConsulVersion	No description.
resetPlanName	No description.
resetTags	No description.
resetTimeouts	No description.
resetVnetCidr	No description.

---

toString

public toString(): string

Returns a string representation of this construct.

addOverride

public addOverride(path: string, value: any): void

path^Required

• Type: string

---

value^Required

• Type: any

---

overrideLogicalId

public overrideLogicalId(newLogicalId: string): void

Overrides the auto-generated logical ID with a specific ID.

newLogicalId^Required

• Type: string

The new logical ID to use for this stack element.

---

resetOverrideLogicalId

public resetOverrideLogicalId(): void

Resets a previously passed logical Id to use the auto-generated logical id again.

toHclTerraform

public toHclTerraform(): any

toMetadata

public toMetadata(): any

toTerraform

public toTerraform(): any

Adds this resource to the terraform JSON output.

addMoveTarget

public addMoveTarget(moveTarget: string): void

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

moveTarget^Required

• Type: string

The string move target that will correspond to this resource.

---

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

hasResourceMove

public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById

importFrom

public importFrom(id: string, provider?: TerraformProvider): void

id^Required

• Type: string

---

provider^Optional

• Type: cdktf.TerraformProvider

---

interpolationForAttribute

public interpolationForAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

moveFromId

public moveFromId(id: string): void

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

id^Required

• Type: string

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

---

moveTo

public moveTo(moveTarget: string, index?: string | number): void

Moves this resource to the target resource given by moveTarget.

moveTarget^Required

• Type: string

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

---

index^Optional

• Type: string | number

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

---

moveToId

public moveToId(id: string): void

Moves this resource to the resource corresponding to "id".

id^Required

• Type: string

Full id of resource to move to, e.g. "aws_s3_bucket.example".

---

putTimeouts

public putTimeouts(value: ClusterTimeouts): void

value^Required

• Type: ClusterTimeouts

---

resetAuditLoggingEnabled

public resetAuditLoggingEnabled(): void

resetAuditLogStorageContainerUrl

public resetAuditLogStorageContainerUrl(): void

resetClusterName

public resetClusterName(): void

resetConsulDatacenter

public resetConsulDatacenter(): void

resetConsulExternalEndpoint

public resetConsulExternalEndpoint(): void

resetConsulFederationToken

public resetConsulFederationToken(): void

resetId

public resetId(): void

resetLocation

public resetLocation(): void

resetManagedResourceGroupName

public resetManagedResourceGroupName(): void

resetMinConsulVersion

public resetMinConsulVersion(): void

resetPlanName

public resetPlanName(): void

resetTags

public resetTags(): void

resetTimeouts

public resetTimeouts(): void

resetVnetCidr

public resetVnetCidr(): void

Static Functions

Name	Description
isConstruct	Checks if x is a construct.
isTerraformElement	No description.
isTerraformResource	No description.
generateConfigForImport	Generates CDKTF code for importing a Cluster resource upon running "cdktf plan ".

---

isConstruct

import { cluster } from '@cdktf/provider-hcs'

cluster.Cluster.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

x^Required

• Type: any

Any object.

---

isTerraformElement

import { cluster } from '@cdktf/provider-hcs'

cluster.Cluster.isTerraformElement(x: any)

x^Required

• Type: any

---

isTerraformResource

import { cluster } from '@cdktf/provider-hcs'

cluster.Cluster.isTerraformResource(x: any)

x^Required

• Type: any

---

generateConfigForImport

import { cluster } from '@cdktf/provider-hcs'

cluster.Cluster.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)

Generates CDKTF code for importing a Cluster resource upon running "cdktf plan ".

scope^Required

• Type: constructs.Construct

The scope in which to define this construct.

---

importToId^Required

• Type: string

The construct id used in the generated config for the Cluster to import.

---

importFromId^Required

• Type: string

The id of the existing Cluster that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#import import section} in the documentation of this resource for the id to use

---

provider^Optional

• Type: cdktf.TerraformProvider

? Optional instance of the provider where the Cluster to import is found.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
cdktfStack	cdktf.TerraformStack	No description.
fqn	string	No description.
friendlyUniqueId	string	No description.
terraformMetaArguments	{[ key: string ]: any}	No description.
terraformResourceType	string	No description.
terraformGeneratorMetadata	cdktf.TerraformProviderGeneratorMetadata	No description.
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	string[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
blobContainerName	string	No description.
consulAutomaticUpgrades	cdktf.IResolvable	No description.
consulCaFile	string	No description.
consulClusterId	string	No description.
consulConfigFile	string	No description.
consulConnect	cdktf.IResolvable	No description.
consulExternalEndpointUrl	string	No description.
consulPrivateEndpointUrl	string	No description.
consulRootTokenAccessorId	string	No description.
consulRootTokenSecretId	string	No description.
consulSnapshotInterval	string	No description.
consulSnapshotRetention	string	No description.
consulVersion	string	No description.
managedApplicationId	string	No description.
managedIdentityName	string	No description.
state	string	No description.
storageAccountName	string	No description.
storageAccountResourceGroup	string	No description.
timeouts	ClusterTimeoutsOutputReference	No description.
vnetId	string	No description.
vnetName	string	No description.
vnetResourceGroupName	string	No description.
auditLoggingEnabledInput	boolean | cdktf.IResolvable	No description.
auditLogStorageContainerUrlInput	string	No description.
clusterModeInput	string	No description.
clusterNameInput	string	No description.
consulDatacenterInput	string	No description.
consulExternalEndpointInput	boolean | cdktf.IResolvable	No description.
consulFederationTokenInput	string	No description.
emailInput	string	No description.
idInput	string	No description.
locationInput	string	No description.
managedApplicationNameInput	string	No description.
managedResourceGroupNameInput	string	No description.
minConsulVersionInput	string	No description.
planNameInput	string	No description.
resourceGroupNameInput	string	No description.
tagsInput	{[ key: string ]: string}	No description.
timeoutsInput	cdktf.IResolvable | ClusterTimeouts	No description.
vnetCidrInput	string	No description.
auditLoggingEnabled	boolean | cdktf.IResolvable	No description.
auditLogStorageContainerUrl	string	No description.
clusterMode	string	No description.
clusterName	string	No description.
consulDatacenter	string	No description.
consulExternalEndpoint	boolean | cdktf.IResolvable	No description.
consulFederationToken	string	No description.
email	string	No description.
id	string	No description.
location	string	No description.
managedApplicationName	string	No description.
managedResourceGroupName	string	No description.
minConsulVersion	string	No description.
planName	string	No description.
resourceGroupName	string	No description.
tags	{[ key: string ]: string}	No description.
vnetCidr	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

cdktfStack^Required

public readonly cdktfStack: TerraformStack;

• Type: cdktf.TerraformStack

---

fqn^Required

public readonly fqn: string;

• Type: string

---

friendlyUniqueId^Required

public readonly friendlyUniqueId: string;

• Type: string

---

terraformMetaArguments^Required

public readonly terraformMetaArguments: {[ key: string ]: any};

• Type: {[ key: string ]: any}

---

terraformResourceType^Required

public readonly terraformResourceType: string;

• Type: string

---

terraformGeneratorMetadata^Optional

public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;

• Type: cdktf.TerraformProviderGeneratorMetadata

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: string[];

• Type: string[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

blobContainerName^Required

public readonly blobContainerName: string;

• Type: string

---

consulAutomaticUpgrades^Required

public readonly consulAutomaticUpgrades: IResolvable;

• Type: cdktf.IResolvable

---

consulCaFile^Required

public readonly consulCaFile: string;

• Type: string

---

consulClusterId^Required

public readonly consulClusterId: string;

• Type: string

---

consulConfigFile^Required

public readonly consulConfigFile: string;

• Type: string

---

consulConnect^Required

public readonly consulConnect: IResolvable;

• Type: cdktf.IResolvable

---

consulExternalEndpointUrl^Required

public readonly consulExternalEndpointUrl: string;

• Type: string

---

consulPrivateEndpointUrl^Required

public readonly consulPrivateEndpointUrl: string;

• Type: string

---

consulRootTokenAccessorId^Required

public readonly consulRootTokenAccessorId: string;

• Type: string

---

consulRootTokenSecretId^Required

public readonly consulRootTokenSecretId: string;

• Type: string

---

consulSnapshotInterval^Required

public readonly consulSnapshotInterval: string;

• Type: string

---

consulSnapshotRetention^Required

public readonly consulSnapshotRetention: string;

• Type: string

---

consulVersion^Required

public readonly consulVersion: string;

• Type: string

---

managedApplicationId^Required

public readonly managedApplicationId: string;

• Type: string

---

managedIdentityName^Required

public readonly managedIdentityName: string;

• Type: string

---

state^Required

public readonly state: string;

• Type: string

---

storageAccountName^Required

public readonly storageAccountName: string;

• Type: string

---

storageAccountResourceGroup^Required

public readonly storageAccountResourceGroup: string;

• Type: string

---

timeouts^Required

public readonly timeouts: ClusterTimeoutsOutputReference;

• Type: ClusterTimeoutsOutputReference

---

vnetId^Required

public readonly vnetId: string;

• Type: string

---

vnetName^Required

public readonly vnetName: string;

• Type: string

---

vnetResourceGroupName^Required

public readonly vnetResourceGroupName: string;

• Type: string

---

auditLoggingEnabledInput^Optional

public readonly auditLoggingEnabledInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

auditLogStorageContainerUrlInput^Optional

public readonly auditLogStorageContainerUrlInput: string;

• Type: string

---

clusterModeInput^Optional

public readonly clusterModeInput: string;

• Type: string

---

clusterNameInput^Optional

public readonly clusterNameInput: string;

• Type: string

---

consulDatacenterInput^Optional

public readonly consulDatacenterInput: string;

• Type: string

---

consulExternalEndpointInput^Optional

public readonly consulExternalEndpointInput: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

consulFederationTokenInput^Optional

public readonly consulFederationTokenInput: string;

• Type: string

---

emailInput^Optional

public readonly emailInput: string;

• Type: string

---

idInput^Optional

public readonly idInput: string;

• Type: string

---

locationInput^Optional

public readonly locationInput: string;

• Type: string

---

managedApplicationNameInput^Optional

public readonly managedApplicationNameInput: string;

• Type: string

---

managedResourceGroupNameInput^Optional

public readonly managedResourceGroupNameInput: string;

• Type: string

---

minConsulVersionInput^Optional

public readonly minConsulVersionInput: string;

• Type: string

---

planNameInput^Optional

public readonly planNameInput: string;

• Type: string

---

resourceGroupNameInput^Optional

public readonly resourceGroupNameInput: string;

• Type: string

---

tagsInput^Optional

public readonly tagsInput: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

timeoutsInput^Optional

public readonly timeoutsInput: IResolvable | ClusterTimeouts;

• Type: cdktf.IResolvable | ClusterTimeouts

---

vnetCidrInput^Optional

public readonly vnetCidrInput: string;

• Type: string

---

auditLoggingEnabled^Required

public readonly auditLoggingEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

auditLogStorageContainerUrl^Required

public readonly auditLogStorageContainerUrl: string;

• Type: string

---

clusterMode^Required

public readonly clusterMode: string;

• Type: string

---

clusterName^Required

public readonly clusterName: string;

• Type: string

---

consulDatacenter^Required

public readonly consulDatacenter: string;

• Type: string

---

consulExternalEndpoint^Required

public readonly consulExternalEndpoint: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

---

consulFederationToken^Required

public readonly consulFederationToken: string;

• Type: string

---

email^Required

public readonly email: string;

• Type: string

---

id^Required

public readonly id: string;

• Type: string

---

location^Required

public readonly location: string;

• Type: string

---

managedApplicationName^Required

public readonly managedApplicationName: string;

• Type: string

---

managedResourceGroupName^Required

public readonly managedResourceGroupName: string;

• Type: string

---

minConsulVersion^Required

public readonly minConsulVersion: string;

• Type: string

---

planName^Required

public readonly planName: string;

• Type: string

---

resourceGroupName^Required

public readonly resourceGroupName: string;

• Type: string

---

tags^Required

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

vnetCidr^Required

public readonly vnetCidr: string;

• Type: string

---

Constants

Name	Type	Description
tfResourceType	string	No description.

---

tfResourceType^Required

public readonly tfResourceType: string;

• Type: string

---

Structs

ClusterConfig

Initializer

import { cluster } from '@cdktf/provider-hcs'

const clusterConfig: cluster.ClusterConfig = { ... }

Properties

Name	Type	Description
connection	cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection	No description.
count	number | cdktf.TerraformCount	No description.
dependsOn	cdktf.ITerraformDependable[]	No description.
forEach	cdktf.ITerraformIterator	No description.
lifecycle	cdktf.TerraformResourceLifecycle	No description.
provider	cdktf.TerraformProvider	No description.
provisioners	cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]	No description.
clusterMode	string	The mode of the cluster ('Development' or 'Production').
email	string	The contact email for the primary owner of the cluster.
managedApplicationName	string	The name of the HCS Azure Managed Application.
resourceGroupName	string	The name of the Resource Group in which the HCS Azure Managed Application belongs.
auditLoggingEnabled	boolean | cdktf.IResolvable	Enables Consul audit logging for the cluster resource. Defaults to false.
auditLogStorageContainerUrl	string	The url of the Azure blob storage container to write audit logs to if audit_logging_enabled is true.
clusterName	string	The name of the cluster Managed Resource. If not specified, it is defaulted to the value of managed_application_name.
consulDatacenter	string	The Consul data center name of the cluster. If not specified, it is defaulted to the value of managed_application_name.
consulExternalEndpoint	boolean | cdktf.IResolvable	Denotes that the cluster has an external endpoint for the Consul UI. Defaults to false.
consulFederationToken	string	The token used to join a federation of Consul clusters.
id	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#id Cluster#id}.
location	string	The Azure region that the cluster is deployed to.
managedResourceGroupName	string	The name of the Managed Resource Group in which the cluster resources belong.
minConsulVersion	string	The minimum Consul version of the cluster.
planName	string	The name of the Azure Marketplace HCS plan for the cluster.
tags	{[ key: string ]: string}	A mapping of tags to assign to the HCS Azure Managed Application resource.
timeouts	ClusterTimeouts	timeouts block.
vnetCidr	string	The VNET CIDR range of the Consul cluster. Defaults to 172.25.16.0/24.

---

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: cdktf.SSHProvisionerConnection | cdktf.WinrmProvisionerConnection

---

count^Optional

public readonly count: number | TerraformCount;

• Type: number | cdktf.TerraformCount

---

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: cdktf.ITerraformDependable[]

---

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: cdktf.ITerraformIterator

---

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: cdktf.TerraformResourceLifecycle

---

provider^Optional

public readonly provider: TerraformProvider;

• Type: cdktf.TerraformProvider

---

provisioners^Optional

public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];

• Type: cdktf.FileProvisioner | cdktf.LocalExecProvisioner | cdktf.RemoteExecProvisioner[]

---

clusterMode^Required

public readonly clusterMode: string;

• Type: string

The mode of the cluster ('Development' or 'Production').

Development clusters only have a single Consul server. Production clusters are fully supported, full featured, and deploy with a minimum of three hosts.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#cluster_mode Cluster#cluster_mode}

---

email^Required

public readonly email: string;

• Type: string

The contact email for the primary owner of the cluster.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#email Cluster#email}

---

managedApplicationName^Required

public readonly managedApplicationName: string;

• Type: string

The name of the HCS Azure Managed Application.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#managed_application_name Cluster#managed_application_name}

---

resourceGroupName^Required

public readonly resourceGroupName: string;

• Type: string

The name of the Resource Group in which the HCS Azure Managed Application belongs.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#resource_group_name Cluster#resource_group_name}

---

auditLoggingEnabled^Optional

public readonly auditLoggingEnabled: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Enables Consul audit logging for the cluster resource. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#audit_logging_enabled Cluster#audit_logging_enabled}

---

auditLogStorageContainerUrl^Optional

public readonly auditLogStorageContainerUrl: string;

• Type: string

The url of the Azure blob storage container to write audit logs to if audit_logging_enabled is true.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#audit_log_storage_container_url Cluster#audit_log_storage_container_url}

---

clusterName^Optional

public readonly clusterName: string;

• Type: string

The name of the cluster Managed Resource. If not specified, it is defaulted to the value of managed_application_name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#cluster_name Cluster#cluster_name}

---

consulDatacenter^Optional

public readonly consulDatacenter: string;

• Type: string

The Consul data center name of the cluster. If not specified, it is defaulted to the value of managed_application_name.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#consul_datacenter Cluster#consul_datacenter}

---

consulExternalEndpoint^Optional

public readonly consulExternalEndpoint: boolean | IResolvable;

• Type: boolean | cdktf.IResolvable

Denotes that the cluster has an external endpoint for the Consul UI. Defaults to false.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#consul_external_endpoint Cluster#consul_external_endpoint}

---

consulFederationToken^Optional

public readonly consulFederationToken: string;

• Type: string

The token used to join a federation of Consul clusters.

If the cluster is not part of a federation, this field will be empty.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#consul_federation_token Cluster#consul_federation_token}

---

id^Optional

public readonly id: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#id Cluster#id}.

Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

---

location^Optional

public readonly location: string;

• Type: string

The Azure region that the cluster is deployed to.

If not specified, it is defaulted to the region of the Resource Group the Managed Application belongs to.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#location Cluster#location}

---

managedResourceGroupName^Optional

public readonly managedResourceGroupName: string;

• Type: string

The name of the Managed Resource Group in which the cluster resources belong.

If not specified, it is defaulted to the value of managed_application_name with 'mrg-' prepended.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#managed_resource_group_name Cluster#managed_resource_group_name}

---

minConsulVersion^Optional

public readonly minConsulVersion: string;

• Type: string

The minimum Consul version of the cluster.

If not specified, it is defaulted to the version that is currently recommended by HCS.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#min_consul_version Cluster#min_consul_version}

---

planName^Optional

public readonly planName: string;

• Type: string

The name of the Azure Marketplace HCS plan for the cluster.

If not specified, it will default to the current HCS default plan (see the hcs_plan_defaults data source).

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#plan_name Cluster#plan_name}

---

tags^Optional

public readonly tags: {[ key: string ]: string};

• Type: {[ key: string ]: string}

A mapping of tags to assign to the HCS Azure Managed Application resource.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#tags Cluster#tags}

---

timeouts^Optional

public readonly timeouts: ClusterTimeouts;

• Type: ClusterTimeouts

timeouts block.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#timeouts Cluster#timeouts}

---

vnetCidr^Optional

public readonly vnetCidr: string;

• Type: string

The VNET CIDR range of the Consul cluster. Defaults to 172.25.16.0/24.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#vnet_cidr Cluster#vnet_cidr}

---

ClusterTimeouts

Initializer

import { cluster } from '@cdktf/provider-hcs'

const clusterTimeouts: cluster.ClusterTimeouts = { ... }

Properties

Name	Type	Description
create	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#create Cluster#create}.
default	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#default Cluster#default}.
delete	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#delete Cluster#delete}.
update	string	Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#update Cluster#update}.

---

create^Optional

public readonly create: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#create Cluster#create}.

---

default^Optional

public readonly default: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#default Cluster#default}.

---

delete^Optional

public readonly delete: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#delete Cluster#delete}.

---

update^Optional

public readonly update: string;

• Type: string

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#update Cluster#update}.

---

Classes

ClusterTimeoutsOutputReference

Initializers

import { cluster } from '@cdktf/provider-hcs'

new cluster.ClusterTimeoutsOutputReference(terraformResource: IInterpolatingParent, terraformAttribute: string)

Name	Type	Description
terraformResource	cdktf.IInterpolatingParent	The parent resource.
terraformAttribute	string	The attribute on the parent resource this class is referencing.

---

terraformResource^Required

• Type: cdktf.IInterpolatingParent

The parent resource.

---

terraformAttribute^Required

• Type: string

The attribute on the parent resource this class is referencing.

---

Methods

Name	Description
computeFqn	No description.
getAnyMapAttribute	No description.
getBooleanAttribute	No description.
getBooleanMapAttribute	No description.
getListAttribute	No description.
getNumberAttribute	No description.
getNumberListAttribute	No description.
getNumberMapAttribute	No description.
getStringAttribute	No description.
getStringMapAttribute	No description.
interpolationForAttribute	No description.
resolve	Produce the Token's value at resolution time.
toString	Return a string representation of this resolvable object.
resetCreate	No description.
resetDefault	No description.
resetDelete	No description.
resetUpdate	No description.

---

computeFqn

public computeFqn(): string

getAnyMapAttribute

public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}

terraformAttribute^Required

• Type: string

---

getBooleanAttribute

public getBooleanAttribute(terraformAttribute: string): IResolvable

terraformAttribute^Required

• Type: string

---

getBooleanMapAttribute

public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}

terraformAttribute^Required

• Type: string

---

getListAttribute

public getListAttribute(terraformAttribute: string): string[]

terraformAttribute^Required

• Type: string

---

getNumberAttribute

public getNumberAttribute(terraformAttribute: string): number

terraformAttribute^Required

• Type: string

---

getNumberListAttribute

public getNumberListAttribute(terraformAttribute: string): number[]

terraformAttribute^Required

• Type: string

---

getNumberMapAttribute

public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}

terraformAttribute^Required

• Type: string

---

getStringAttribute

public getStringAttribute(terraformAttribute: string): string

terraformAttribute^Required

• Type: string

---

getStringMapAttribute

public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}

terraformAttribute^Required

• Type: string

---

interpolationForAttribute

public interpolationForAttribute(property: string): IResolvable

property^Required

• Type: string

---

resolve

public resolve(_context: IResolveContext): any

Produce the Token's value at resolution time.

_context^Required

• Type: cdktf.IResolveContext

---

toString

public toString(): string

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate

public resetCreate(): void

resetDefault

public resetDefault(): void

resetDelete

public resetDelete(): void

resetUpdate

public resetUpdate(): void

Properties

Name	Type	Description
creationStack	string[]	The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn	string	No description.
createInput	string	No description.
defaultInput	string	No description.
deleteInput	string	No description.
updateInput	string	No description.
create	string	No description.
default	string	No description.
delete	string	No description.
update	string	No description.
internalValue	cdktf.IResolvable | ClusterTimeouts	No description.

---

creationStack^Required

public readonly creationStack: string[];

• Type: string[]

The creation stack of this resolvable which will be appended to errors thrown during resolution.

If this returns an empty array the stack will not be attached.

---

fqn^Required

public readonly fqn: string;

• Type: string

---

createInput^Optional

public readonly createInput: string;

• Type: string

---

defaultInput^Optional

public readonly defaultInput: string;

• Type: string

---

deleteInput^Optional

public readonly deleteInput: string;

• Type: string

---

updateInput^Optional

public readonly updateInput: string;

• Type: string

---

create^Required

public readonly create: string;

• Type: string

---

default^Required

public readonly default: string;

• Type: string

---

delete^Required

public readonly delete: string;

• Type: string

---

update^Required

public readonly update: string;

• Type: string

---

internalValue^Optional

public readonly internalValue: IResolvable | ClusterTimeouts;

• Type: cdktf.IResolvable | ClusterTimeouts

---