Skip to content
This repository has been archived by the owner on Jan 17, 2024. It is now read-only.

Latest commit

 

History

History
2540 lines (1590 loc) · 106 KB

cluster.java.md

File metadata and controls

2540 lines (1590 loc) · 106 KB

cluster Submodule

Constructs

Cluster

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

Initializers 

import com.hashicorp.cdktf.providers.hcs.cluster.Cluster;

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

The scope in which to define this construct.

idRequired
  • Type: java.lang.String

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
clusterModeRequired
  • Type: java.lang.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}

emailRequired
  • Type: java.lang.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}

managedApplicationNameRequired
  • Type: java.lang.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}

resourceGroupNameRequired
  • Type: java.lang.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}

auditLoggingEnabledOptional
  • Type: java.lang.Boolean OR com.hashicorp.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}

auditLogStorageContainerUrlOptional
  • Type: java.lang.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}

clusterNameOptional
  • Type: java.lang.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}

consulDatacenterOptional
  • Type: java.lang.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}

consulExternalEndpointOptional
  • Type: java.lang.Boolean OR com.hashicorp.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}

consulFederationTokenOptional
  • Type: java.lang.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}

idOptional
  • Type: java.lang.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.

locationOptional
  • Type: java.lang.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}

managedResourceGroupNameOptional
  • Type: java.lang.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}

minConsulVersionOptional
  • Type: java.lang.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}

planNameOptional
  • Type: java.lang.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}

tagsOptional
  • Type: java.util.Map<java.lang.String, java.lang.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}

timeoutsOptional

timeouts block.

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

vnetCidrOptional
  • Type: java.lang.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}

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 java.lang.String toString()

Returns a string representation of this construct.

addOverride 
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
  • Type: java.lang.String
valueRequired
  • Type: java.lang.Object
overrideLogicalId 
public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalIdRequired
  • Type: java.lang.String

The new logical ID to use for this stack element.

resetOverrideLogicalId 
public void resetOverrideLogicalId()

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

toHclTerraform 
public java.lang.Object toHclTerraform()
toMetadata 
public java.lang.Object toMetadata()
toTerraform 
public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

addMoveTarget 
public void addMoveTarget(java.lang.String moveTarget)

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

moveTargetRequired
  • Type: java.lang.String

The string move target that will correspond to this resource.

getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
hasResourceMove 
public TerraformResourceMoveByTarget OR TerraformResourceMoveById hasResourceMove()
importFrom 
public void importFrom(java.lang.String id)
public void importFrom(java.lang.String id, TerraformProvider provider)
idRequired
  • Type: java.lang.String
providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
moveFromId 
public void moveFromId(java.lang.String id)

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.

idRequired
  • Type: java.lang.String

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

moveTo 
public void moveTo(java.lang.String moveTarget)
public void moveTo(java.lang.String moveTarget, java.lang.String OR java.lang.Number index)

Moves this resource to the target resource given by moveTarget.

moveTargetRequired
  • Type: java.lang.String

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

indexOptional
  • Type: java.lang.String OR java.lang.Number

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

moveToId 
public void moveToId(java.lang.String id)

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

idRequired
  • Type: java.lang.String

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

putTimeouts 
public void putTimeouts(ClusterTimeouts value)
valueRequired
resetAuditLoggingEnabled 
public void resetAuditLoggingEnabled()
resetAuditLogStorageContainerUrl 
public void resetAuditLogStorageContainerUrl()
resetClusterName 
public void resetClusterName()
resetConsulDatacenter 
public void resetConsulDatacenter()
resetConsulExternalEndpoint 
public void resetConsulExternalEndpoint()
resetConsulFederationToken 
public void resetConsulFederationToken()
resetId 
public void resetId()
resetLocation 
public void resetLocation()
resetManagedResourceGroupName 
public void resetManagedResourceGroupName()
resetMinConsulVersion 
public void resetMinConsulVersion()
resetPlanName 
public void resetPlanName()
resetTags 
public void resetTags()
resetTimeouts 
public void resetTimeouts()
resetVnetCidr 
public void resetVnetCidr()

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 com.hashicorp.cdktf.providers.hcs.cluster.Cluster;

Cluster.isConstruct(java.lang.Object x)

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.

xRequired
  • Type: java.lang.Object

Any object.

isTerraformElement 
import com.hashicorp.cdktf.providers.hcs.cluster.Cluster;

Cluster.isTerraformElement(java.lang.Object x)
xRequired
  • Type: java.lang.Object
isTerraformResource 
import com.hashicorp.cdktf.providers.hcs.cluster.Cluster;

Cluster.isTerraformResource(java.lang.Object x)
xRequired
  • Type: java.lang.Object
generateConfigForImport 
import com.hashicorp.cdktf.providers.hcs.cluster.Cluster;

Cluster.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId),Cluster.generateConfigForImport(Construct scope, java.lang.String importToId, java.lang.String importFromId, TerraformProvider provider)

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

scopeRequired
  • Type: software.constructs.Construct

The scope in which to define this construct.

importToIdRequired
  • Type: java.lang.String

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

importFromIdRequired
  • Type: java.lang.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

providerOptional
  • Type: com.hashicorp.cdktf.TerraformProvider

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

Properties

Name Type Description
node software.constructs.Node The tree node.
cdktfStack com.hashicorp.cdktf.TerraformStack No description.
fqn java.lang.String No description.
friendlyUniqueId java.lang.String No description.
terraformMetaArguments java.util.Map<java.lang.String, java.lang.Object> No description.
terraformResourceType java.lang.String No description.
terraformGeneratorMetadata com.hashicorp.cdktf.TerraformProviderGeneratorMetadata No description.
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<java.lang.String> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
blobContainerName java.lang.String No description.
consulAutomaticUpgrades com.hashicorp.cdktf.IResolvable No description.
consulCaFile java.lang.String No description.
consulClusterId java.lang.String No description.
consulConfigFile java.lang.String No description.
consulConnect com.hashicorp.cdktf.IResolvable No description.
consulExternalEndpointUrl java.lang.String No description.
consulPrivateEndpointUrl java.lang.String No description.
consulRootTokenAccessorId java.lang.String No description.
consulRootTokenSecretId java.lang.String No description.
consulSnapshotInterval java.lang.String No description.
consulSnapshotRetention java.lang.String No description.
consulVersion java.lang.String No description.
managedApplicationId java.lang.String No description.
managedIdentityName java.lang.String No description.
state java.lang.String No description.
storageAccountName java.lang.String No description.
storageAccountResourceGroup java.lang.String No description.
timeouts ClusterTimeoutsOutputReference No description.
vnetId java.lang.String No description.
vnetName java.lang.String No description.
vnetResourceGroupName java.lang.String No description.
auditLoggingEnabledInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
auditLogStorageContainerUrlInput java.lang.String No description.
clusterModeInput java.lang.String No description.
clusterNameInput java.lang.String No description.
consulDatacenterInput java.lang.String No description.
consulExternalEndpointInput java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
consulFederationTokenInput java.lang.String No description.
emailInput java.lang.String No description.
idInput java.lang.String No description.
locationInput java.lang.String No description.
managedApplicationNameInput java.lang.String No description.
managedResourceGroupNameInput java.lang.String No description.
minConsulVersionInput java.lang.String No description.
planNameInput java.lang.String No description.
resourceGroupNameInput java.lang.String No description.
tagsInput java.util.Map<java.lang.String, java.lang.String> No description.
timeoutsInput com.hashicorp.cdktf.IResolvable OR ClusterTimeouts No description.
vnetCidrInput java.lang.String No description.
auditLoggingEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
auditLogStorageContainerUrl java.lang.String No description.
clusterMode java.lang.String No description.
clusterName java.lang.String No description.
consulDatacenter java.lang.String No description.
consulExternalEndpoint java.lang.Boolean OR com.hashicorp.cdktf.IResolvable No description.
consulFederationToken java.lang.String No description.
email java.lang.String No description.
id java.lang.String No description.
location java.lang.String No description.
managedApplicationName java.lang.String No description.
managedResourceGroupName java.lang.String No description.
minConsulVersion java.lang.String No description.
planName java.lang.String No description.
resourceGroupName java.lang.String No description.
tags java.util.Map<java.lang.String, java.lang.String> No description.
vnetCidr java.lang.String No description.
nodeRequired 
public Node getNode();
  • Type: software.constructs.Node

The tree node.

cdktfStackRequired 
public TerraformStack getCdktfStack();
  • Type: com.hashicorp.cdktf.TerraformStack
fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
friendlyUniqueIdRequired 
public java.lang.String getFriendlyUniqueId();
  • Type: java.lang.String
terraformMetaArgumentsRequired 
public java.util.Map<java.lang.String, java.lang.Object> getTerraformMetaArguments();
  • Type: java.util.Map<java.lang.String, java.lang.Object>
terraformResourceTypeRequired 
public java.lang.String getTerraformResourceType();
  • Type: java.lang.String
terraformGeneratorMetadataOptional 
public TerraformProviderGeneratorMetadata getTerraformGeneratorMetadata();
  • Type: com.hashicorp.cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<java.lang.String> getDependsOn();
  • Type: java.util.List<java.lang.String>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
blobContainerNameRequired 
public java.lang.String getBlobContainerName();
  • Type: java.lang.String
consulAutomaticUpgradesRequired 
public IResolvable getConsulAutomaticUpgrades();
  • Type: com.hashicorp.cdktf.IResolvable
consulCaFileRequired 
public java.lang.String getConsulCaFile();
  • Type: java.lang.String
consulClusterIdRequired 
public java.lang.String getConsulClusterId();
  • Type: java.lang.String
consulConfigFileRequired 
public java.lang.String getConsulConfigFile();
  • Type: java.lang.String
consulConnectRequired 
public IResolvable getConsulConnect();
  • Type: com.hashicorp.cdktf.IResolvable
consulExternalEndpointUrlRequired 
public java.lang.String getConsulExternalEndpointUrl();
  • Type: java.lang.String
consulPrivateEndpointUrlRequired 
public java.lang.String getConsulPrivateEndpointUrl();
  • Type: java.lang.String
consulRootTokenAccessorIdRequired 
public java.lang.String getConsulRootTokenAccessorId();
  • Type: java.lang.String
consulRootTokenSecretIdRequired 
public java.lang.String getConsulRootTokenSecretId();
  • Type: java.lang.String
consulSnapshotIntervalRequired 
public java.lang.String getConsulSnapshotInterval();
  • Type: java.lang.String
consulSnapshotRetentionRequired 
public java.lang.String getConsulSnapshotRetention();
  • Type: java.lang.String
consulVersionRequired 
public java.lang.String getConsulVersion();
  • Type: java.lang.String
managedApplicationIdRequired 
public java.lang.String getManagedApplicationId();
  • Type: java.lang.String
managedIdentityNameRequired 
public java.lang.String getManagedIdentityName();
  • Type: java.lang.String
stateRequired 
public java.lang.String getState();
  • Type: java.lang.String
storageAccountNameRequired 
public java.lang.String getStorageAccountName();
  • Type: java.lang.String
storageAccountResourceGroupRequired 
public java.lang.String getStorageAccountResourceGroup();
  • Type: java.lang.String
timeoutsRequired 
public ClusterTimeoutsOutputReference getTimeouts();
vnetIdRequired 
public java.lang.String getVnetId();
  • Type: java.lang.String
vnetNameRequired 
public java.lang.String getVnetName();
  • Type: java.lang.String
vnetResourceGroupNameRequired 
public java.lang.String getVnetResourceGroupName();
  • Type: java.lang.String
auditLoggingEnabledInputOptional 
public java.lang.Object getAuditLoggingEnabledInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
auditLogStorageContainerUrlInputOptional 
public java.lang.String getAuditLogStorageContainerUrlInput();
  • Type: java.lang.String
clusterModeInputOptional 
public java.lang.String getClusterModeInput();
  • Type: java.lang.String
clusterNameInputOptional 
public java.lang.String getClusterNameInput();
  • Type: java.lang.String
consulDatacenterInputOptional 
public java.lang.String getConsulDatacenterInput();
  • Type: java.lang.String
consulExternalEndpointInputOptional 
public java.lang.Object getConsulExternalEndpointInput();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
consulFederationTokenInputOptional 
public java.lang.String getConsulFederationTokenInput();
  • Type: java.lang.String
emailInputOptional 
public java.lang.String getEmailInput();
  • Type: java.lang.String
idInputOptional 
public java.lang.String getIdInput();
  • Type: java.lang.String
locationInputOptional 
public java.lang.String getLocationInput();
  • Type: java.lang.String
managedApplicationNameInputOptional 
public java.lang.String getManagedApplicationNameInput();
  • Type: java.lang.String
managedResourceGroupNameInputOptional 
public java.lang.String getManagedResourceGroupNameInput();
  • Type: java.lang.String
minConsulVersionInputOptional 
public java.lang.String getMinConsulVersionInput();
  • Type: java.lang.String
planNameInputOptional 
public java.lang.String getPlanNameInput();
  • Type: java.lang.String
resourceGroupNameInputOptional 
public java.lang.String getResourceGroupNameInput();
  • Type: java.lang.String
tagsInputOptional 
public java.util.Map<java.lang.String, java.lang.String> getTagsInput();
  • Type: java.util.Map<java.lang.String, java.lang.String>
timeoutsInputOptional 
public java.lang.Object getTimeoutsInput();
vnetCidrInputOptional 
public java.lang.String getVnetCidrInput();
  • Type: java.lang.String
auditLoggingEnabledRequired 
public java.lang.Object getAuditLoggingEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
auditLogStorageContainerUrlRequired 
public java.lang.String getAuditLogStorageContainerUrl();
  • Type: java.lang.String
clusterModeRequired 
public java.lang.String getClusterMode();
  • Type: java.lang.String
clusterNameRequired 
public java.lang.String getClusterName();
  • Type: java.lang.String
consulDatacenterRequired 
public java.lang.String getConsulDatacenter();
  • Type: java.lang.String
consulExternalEndpointRequired 
public java.lang.Object getConsulExternalEndpoint();
  • Type: java.lang.Boolean OR com.hashicorp.cdktf.IResolvable
consulFederationTokenRequired 
public java.lang.String getConsulFederationToken();
  • Type: java.lang.String
emailRequired 
public java.lang.String getEmail();
  • Type: java.lang.String
idRequired 
public java.lang.String getId();
  • Type: java.lang.String
locationRequired 
public java.lang.String getLocation();
  • Type: java.lang.String
managedApplicationNameRequired 
public java.lang.String getManagedApplicationName();
  • Type: java.lang.String
managedResourceGroupNameRequired 
public java.lang.String getManagedResourceGroupName();
  • Type: java.lang.String
minConsulVersionRequired 
public java.lang.String getMinConsulVersion();
  • Type: java.lang.String
planNameRequired 
public java.lang.String getPlanName();
  • Type: java.lang.String
resourceGroupNameRequired 
public java.lang.String getResourceGroupName();
  • Type: java.lang.String
tagsRequired 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.String>
vnetCidrRequired 
public java.lang.String getVnetCidr();
  • Type: java.lang.String

Constants

Name Type Description
tfResourceType java.lang.String No description.
tfResourceTypeRequired 
public java.lang.String getTfResourceType();
  • Type: java.lang.String

Structs

ClusterConfig

Initializer 

import com.hashicorp.cdktf.providers.hcs.cluster.ClusterConfig;

ClusterConfig.builder()
//  .connection(SSHProvisionerConnection)
//  .connection(WinrmProvisionerConnection)
//  .count(java.lang.Number)
//  .count(TerraformCount)
//  .dependsOn(java.util.List<ITerraformDependable>)
//  .forEach(ITerraformIterator)
//  .lifecycle(TerraformResourceLifecycle)
//  .provider(TerraformProvider)
//  .provisioners(java.util.List<FileProvisioner)
//  .provisioners(LocalExecProvisioner)
//  .provisioners(RemoteExecProvisioner>)
    .clusterMode(java.lang.String)
    .email(java.lang.String)
    .managedApplicationName(java.lang.String)
    .resourceGroupName(java.lang.String)
//  .auditLoggingEnabled(java.lang.Boolean)
//  .auditLoggingEnabled(IResolvable)
//  .auditLogStorageContainerUrl(java.lang.String)
//  .clusterName(java.lang.String)
//  .consulDatacenter(java.lang.String)
//  .consulExternalEndpoint(java.lang.Boolean)
//  .consulExternalEndpoint(IResolvable)
//  .consulFederationToken(java.lang.String)
//  .id(java.lang.String)
//  .location(java.lang.String)
//  .managedResourceGroupName(java.lang.String)
//  .minConsulVersion(java.lang.String)
//  .planName(java.lang.String)
//  .tags(java.util.Map<java.lang.String, java.lang.String>)
//  .timeouts(ClusterTimeouts)
//  .vnetCidr(java.lang.String)
    .build();

Properties

Name Type Description
connection com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection No description.
count java.lang.Number OR com.hashicorp.cdktf.TerraformCount No description.
dependsOn java.util.List<com.hashicorp.cdktf.ITerraformDependable> No description.
forEach com.hashicorp.cdktf.ITerraformIterator No description.
lifecycle com.hashicorp.cdktf.TerraformResourceLifecycle No description.
provider com.hashicorp.cdktf.TerraformProvider No description.
provisioners java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner> No description.
clusterMode java.lang.String The mode of the cluster ('Development' or 'Production').
email java.lang.String The contact email for the primary owner of the cluster.
managedApplicationName java.lang.String The name of the HCS Azure Managed Application.
resourceGroupName java.lang.String The name of the Resource Group in which the HCS Azure Managed Application belongs.
auditLoggingEnabled java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Enables Consul audit logging for the cluster resource. Defaults to false.
auditLogStorageContainerUrl java.lang.String The url of the Azure blob storage container to write audit logs to if audit_logging_enabled is true.
clusterName java.lang.String The name of the cluster Managed Resource. If not specified, it is defaulted to the value of managed_application_name.
consulDatacenter java.lang.String The Consul data center name of the cluster. If not specified, it is defaulted to the value of managed_application_name.
consulExternalEndpoint java.lang.Boolean OR com.hashicorp.cdktf.IResolvable Denotes that the cluster has an external endpoint for the Consul UI. Defaults to false.
consulFederationToken java.lang.String The token used to join a federation of Consul clusters.
id java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#id Cluster#id}.
location java.lang.String The Azure region that the cluster is deployed to.
managedResourceGroupName java.lang.String The name of the Managed Resource Group in which the cluster resources belong.
minConsulVersion java.lang.String The minimum Consul version of the cluster.
planName java.lang.String The name of the Azure Marketplace HCS plan for the cluster.
tags java.util.Map<java.lang.String, java.lang.String> A mapping of tags to assign to the HCS Azure Managed Application resource.
timeouts ClusterTimeouts timeouts block.
vnetCidr java.lang.String The VNET CIDR range of the Consul cluster. Defaults to 172.25.16.0/24.
connectionOptional 
public java.lang.Object getConnection();
  • Type: com.hashicorp.cdktf.SSHProvisionerConnection OR com.hashicorp.cdktf.WinrmProvisionerConnection
countOptional 
public java.lang.Object getCount();
  • Type: java.lang.Number OR com.hashicorp.cdktf.TerraformCount
dependsOnOptional 
public java.util.List<ITerraformDependable> getDependsOn();
  • Type: java.util.List<com.hashicorp.cdktf.ITerraformDependable>
forEachOptional 
public ITerraformIterator getForEach();
  • Type: com.hashicorp.cdktf.ITerraformIterator
lifecycleOptional 
public TerraformResourceLifecycle getLifecycle();
  • Type: com.hashicorp.cdktf.TerraformResourceLifecycle
providerOptional 
public TerraformProvider getProvider();
  • Type: com.hashicorp.cdktf.TerraformProvider
provisionersOptional 
public java.lang.Object getProvisioners();
  • Type: java.util.List<com.hashicorp.cdktf.FileProvisioner OR com.hashicorp.cdktf.LocalExecProvisioner OR com.hashicorp.cdktf.RemoteExecProvisioner>
clusterModeRequired 
public java.lang.String getClusterMode();
  • Type: java.lang.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}

emailRequired 
public java.lang.String getEmail();
  • Type: java.lang.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}

managedApplicationNameRequired 
public java.lang.String getManagedApplicationName();
  • Type: java.lang.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}

resourceGroupNameRequired 
public java.lang.String getResourceGroupName();
  • Type: java.lang.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}

auditLoggingEnabledOptional 
public java.lang.Object getAuditLoggingEnabled();
  • Type: java.lang.Boolean OR com.hashicorp.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}

auditLogStorageContainerUrlOptional 
public java.lang.String getAuditLogStorageContainerUrl();
  • Type: java.lang.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}

clusterNameOptional 
public java.lang.String getClusterName();
  • Type: java.lang.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}

consulDatacenterOptional 
public java.lang.String getConsulDatacenter();
  • Type: java.lang.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}

consulExternalEndpointOptional 
public java.lang.Object getConsulExternalEndpoint();
  • Type: java.lang.Boolean OR com.hashicorp.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}

consulFederationTokenOptional 
public java.lang.String getConsulFederationToken();
  • Type: java.lang.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}

idOptional 
public java.lang.String getId();
  • Type: java.lang.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.

locationOptional 
public java.lang.String getLocation();
  • Type: java.lang.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}

managedResourceGroupNameOptional 
public java.lang.String getManagedResourceGroupName();
  • Type: java.lang.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}

minConsulVersionOptional 
public java.lang.String getMinConsulVersion();
  • Type: java.lang.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}

planNameOptional 
public java.lang.String getPlanName();
  • Type: java.lang.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}

tagsOptional 
public java.util.Map<java.lang.String, java.lang.String> getTags();
  • Type: java.util.Map<java.lang.String, java.lang.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}

timeoutsOptional 
public ClusterTimeouts getTimeouts();

timeouts block.

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

vnetCidrOptional 
public java.lang.String getVnetCidr();
  • Type: java.lang.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 com.hashicorp.cdktf.providers.hcs.cluster.ClusterTimeouts;

ClusterTimeouts.builder()
//  .create(java.lang.String)
//  .default(java.lang.String)
//  .delete(java.lang.String)
//  .update(java.lang.String)
    .build();

Properties

Name Type Description
create java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#create Cluster#create}.
default java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#default Cluster#default}.
delete java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#delete Cluster#delete}.
update java.lang.String Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/hcs/0.5.1/docs/resources/cluster#update Cluster#update}.
createOptional 
public java.lang.String getCreate();
  • Type: java.lang.String

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

defaultOptional 
public java.lang.String getDefault();
  • Type: java.lang.String

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

deleteOptional 
public java.lang.String getDelete();
  • Type: java.lang.String

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

updateOptional 
public java.lang.String getUpdate();
  • Type: java.lang.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 com.hashicorp.cdktf.providers.hcs.cluster.ClusterTimeoutsOutputReference;

new ClusterTimeoutsOutputReference(IInterpolatingParent terraformResource, java.lang.String terraformAttribute);
Name Type Description
terraformResource com.hashicorp.cdktf.IInterpolatingParent The parent resource.
terraformAttribute java.lang.String The attribute on the parent resource this class is referencing.
terraformResourceRequired
  • Type: com.hashicorp.cdktf.IInterpolatingParent

The parent resource.

terraformAttributeRequired
  • Type: java.lang.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 java.lang.String computeFqn()
getAnyMapAttribute 
public java.util.Map<java.lang.String, java.lang.Object> getAnyMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanAttribute 
public IResolvable getBooleanAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getBooleanMapAttribute 
public java.util.Map<java.lang.String, java.lang.Boolean> getBooleanMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getListAttribute 
public java.util.List<java.lang.String> getListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberAttribute 
public java.lang.Number getNumberAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberListAttribute 
public java.util.List<java.lang.Number> getNumberListAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getNumberMapAttribute 
public java.util.Map<java.lang.String, java.lang.Number> getNumberMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringAttribute 
public java.lang.String getStringAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
getStringMapAttribute 
public java.util.Map<java.lang.String, java.lang.String> getStringMapAttribute(java.lang.String terraformAttribute)
terraformAttributeRequired
  • Type: java.lang.String
interpolationForAttribute 
public IResolvable interpolationForAttribute(java.lang.String property)
propertyRequired
  • Type: java.lang.String
resolve 
public java.lang.Object resolve(IResolveContext _context)

Produce the Token's value at resolution time.

_contextRequired
  • Type: com.hashicorp.cdktf.IResolveContext
toString 
public java.lang.String toString()

Return a string representation of this resolvable object.

Returns a reversible string representation.

resetCreate 
public void resetCreate()
resetDefault 
public void resetDefault()
resetDelete 
public void resetDelete()
resetUpdate 
public void resetUpdate()

Properties

Name Type Description
creationStack java.util.List<java.lang.String> The creation stack of this resolvable which will be appended to errors thrown during resolution.
fqn java.lang.String No description.
createInput java.lang.String No description.
defaultInput java.lang.String No description.
deleteInput java.lang.String No description.
updateInput java.lang.String No description.
create java.lang.String No description.
default java.lang.String No description.
delete java.lang.String No description.
update java.lang.String No description.
internalValue com.hashicorp.cdktf.IResolvable OR ClusterTimeouts No description.
creationStackRequired 
public java.util.List<java.lang.String> getCreationStack();
  • Type: java.util.List<java.lang.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.

fqnRequired 
public java.lang.String getFqn();
  • Type: java.lang.String
createInputOptional 
public java.lang.String getCreateInput();
  • Type: java.lang.String
defaultInputOptional 
public java.lang.String getDefaultInput();
  • Type: java.lang.String
deleteInputOptional 
public java.lang.String getDeleteInput();
  • Type: java.lang.String
updateInputOptional 
public java.lang.String getUpdateInput();
  • Type: java.lang.String
createRequired 
public java.lang.String getCreate();
  • Type: java.lang.String
defaultRequired 
public java.lang.String getDefault();
  • Type: java.lang.String
deleteRequired 
public java.lang.String getDelete();
  • Type: java.lang.String
updateRequired 
public java.lang.String getUpdate();
  • Type: java.lang.String
internalValueOptional 
public java.lang.Object getInternalValue();