API Reference for Java

Constructs

App

Represents a cdktf application.

Initializers

import com.hashicorp.cdktf.App;

App.Builder.create()
//  .context(java.util.Map< java.lang.String, java.lang.Object >)
//  .outdir(java.lang.String)
//  .skipValidation(java.lang.Boolean)
//  .stackTraces(java.lang.Boolean)
    .build();

context^Optional

• Type: java.util.Map< java.lang.String, java.lang.Object >
• Default: no additional context

Additional context values for the application.

Context set by the CLI or the context key in cdktf.json has precedence.

Context can be read from any construct using node.getContext(key).

outdir^Optional

• Type: java.lang.String
• Default: CDKTF_OUTDIR if defined, otherwise "cdktf.out"

The directory to output Terraform resources.

skipValidation^Optional

• Type: java.lang.Boolean
• Default: false

Whether to skip the validation during synthesis of the app.

stackTraces^Optional

• Type: java.lang.Boolean

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

crossStackReference

public java.lang.String crossStackReference(TerraformStack fromStack, TerraformStack toStack, java.lang.String identifier)

Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.

fromStack^Required

• Type: TerraformStack

toStack^Required

• Type: TerraformStack

identifier^Required

• Type: java.lang.String

synth

public void synth()

Synthesizes all resources to the output directory.

Static Functions

isConstruct

import com.hashicorp.cdktf.App;

App.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.

x^Required

• Type: java.lang.Object

Any object.

isApp

import com.hashicorp.cdktf.App;

App.isApp(java.lang.Object x)

x^Required

• Type: java.lang.Object

of

import com.hashicorp.cdktf.App;

App.of(IConstruct construct)

construct^Required

• Type: software.constructs.IConstruct

Properties

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

manifest^Required

public Manifest getManifest();

• Type: Manifest

outdir^Required

public java.lang.String getOutdir();

• Type: java.lang.String

The output directory into which resources will be synthesized.

skipValidation^Optional

public java.lang.Boolean getSkipValidation();

• Type: java.lang.Boolean

Whether to skip the validation during synthesis of the app.

targetStackId^Optional

public java.lang.String getTargetStackId();

• Type: java.lang.String

The stack which will be synthesized.

If not set, all stacks will be synthesized.

ArtifactoryBackend

Initializers

import com.hashicorp.cdktf.ArtifactoryBackend;

ArtifactoryBackend.Builder.create(Construct scope)
    .password(java.lang.String)
    .repo(java.lang.String)
    .subpath(java.lang.String)
    .url(java.lang.String)
    .username(java.lang.String)
    .build();

scope^Required

• Type: software.constructs.Construct

password^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The password.

repo^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The repository name.

subpath^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - Path within the repository.

url^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The URL.

Note that this is the base url to artifactory not the full repo and subpath.

username^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The username.

Methods

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)

path^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

• 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.

toMetadata

public java.lang.Object toMetadata()

toTerraform

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: software.constructs.Construct

name^Required

• Type: java.lang.String

_fromStack^Required

• Type: java.lang.String

Static Functions

isConstruct

import com.hashicorp.cdktf.ArtifactoryBackend;

ArtifactoryBackend.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.

x^Required

• Type: java.lang.Object

Any object.

isTerraformElement

import com.hashicorp.cdktf.ArtifactoryBackend;

ArtifactoryBackend.isTerraformElement(java.lang.Object x)

x^Required

• Type: java.lang.Object

isBackend

import com.hashicorp.cdktf.ArtifactoryBackend;

ArtifactoryBackend.isBackend(java.lang.Object x)

x^Required

• Type: java.lang.Object

Properties

node^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public Node getNode();

• Type: software.constructs.Node

The tree node.

cdktfStack^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public TerraformStack getCdktfStack();

• Type: TerraformStack

fqn^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public java.lang.String getFqn();

• Type: java.lang.String

friendlyUniqueId^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

public java.lang.String getFriendlyUniqueId();

• Type: java.lang.String

AzurermBackend

Initializers

import com.hashicorp.cdktf.AzurermBackend;

AzurermBackend.Builder.create(Construct scope)
    .containerName(java.lang.String)
    .key(java.lang.String)
    .storageAccountName(java.lang.String)
//  .accessKey(java.lang.String)
//  .clientCertificatePassword(java.lang.String)
//  .clientCertificatePath(java.lang.String)
//  .clientId(java.lang.String)
//  .clientSecret(java.lang.String)
//  .endpoint(java.lang.String)
//  .environment(java.lang.String)
//  .msiEndpoint(java.lang.String)
//  .oidcRequestToken(java.lang.String)
//  .oidcRequestUrl(java.lang.String)
//  .resourceGroupName(java.lang.String)
//  .sasToken(java.lang.String)
//  .snapshot(java.lang.Boolean)
//  .subscriptionId(java.lang.String)
//  .tenantId(java.lang.String)
//  .useAzureadAuth(java.lang.Boolean)
//  .useMicrosoftGraph(java.lang.Boolean)
//  .useMsi(java.lang.Boolean)
//  .useOidc(java.lang.Boolean)
    .build();

scope^Required

• Type: software.constructs.Construct

containerName^Required

• Type: java.lang.String

(Required) The Name of the Storage Container within the Storage Account.

key^Required

• Type: java.lang.String

(Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.

storageAccountName^Required

• Type: java.lang.String

(Required) The Name of the Storage Account.

accessKey^Optional

• Type: java.lang.String

access_key - (Optional) The Access Key used to access the Blob Storage Account.

This can also be sourced from the ARM_ACCESS_KEY environment variable.

clientCertificatePassword^Optional

• Type: java.lang.String

(Optional) The password associated with the Client Certificate specified in client_certificate_path.

This can also be sourced from the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable.

clientCertificatePath^Optional

• Type: java.lang.String

(Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.

This can also be sourced from the ARM_CLIENT_CERTIFICATE_PATH environment variable.

clientId^Optional

• Type: java.lang.String

(Optional) The Client ID of the Service Principal.

This can also be sourced from the ARM_CLIENT_ID environment variable.

clientSecret^Optional

• Type: java.lang.String

(Optional) The Client Secret of the Service Principal.

This can also be sourced from the ARM_CLIENT_SECRET environment variable.

endpoint^Optional

• Type: java.lang.String

(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.

NOTE: An endpoint should only be configured when using Azure Stack.

environment^Optional

• Type: java.lang.String

(Optional) The Azure Environment which should be used.

This can also be sourced from the ARM_ENVIRONMENT environment variable. Possible values are public, china, german, stack and usgovernment. Defaults to public.

msiEndpoint^Optional

• Type: java.lang.String

(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.

This can also be sourced from the ARM_MSI_ENDPOINT environment variable.

oidcRequestToken^Optional

• Type: java.lang.String

(Optional) The bearer token for the request to the OIDC provider.

This can also be sourced from the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables.

oidcRequestUrl^Optional

• Type: java.lang.String

(Optional) The URL for the OIDC provider from which to request an ID token.

This can also be sourced from the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables.

resourceGroupName^Optional

• Type: java.lang.String

(Required) The Name of the Resource Group in which the Storage Account exists.

sasToken^Optional

• Type: java.lang.String

(Optional) The SAS Token used to access the Blob Storage Account.

This can also be sourced from the ARM_SAS_TOKEN environment variable.

snapshot^Optional

• Type: java.lang.Boolean

(Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?

Defaults to false. This value can also be sourced from the ARM_SNAPSHOT environment variable.

subscriptionId^Optional

• Type: java.lang.String

(Optional) The Subscription ID in which the Storage Account exists.

This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.

tenantId^Optional

• Type: java.lang.String

(Optional) The Tenant ID in which the Subscription exists.

This can also be sourced from the ARM_TENANT_ID environment variable.

useAzureadAuth^Optional

• Type: java.lang.Boolean

(Optional) Should AzureAD Authentication be used to access the Blob Storage Account.

This can also be sourced from the ARM_USE_AZUREAD environment variable.

Note: When using AzureAD for Authentication to Storage you also need to ensure the Storage Blob Data Owner role is assigned.

useMicrosoftGraph^Optional

• Type: java.lang.Boolean

(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?

Defaults to true.

Note: In Terraform 1.2 the Azure Backend uses MSAL (and Microsoft Graph) rather than ADAL (and Azure Active Directory Graph) for authentication by default - you can disable this by setting use_microsoft_graph to false. This setting will be removed in Terraform 1.3, due to Microsoft's deprecation of ADAL.

useMsi^Optional

• Type: java.lang.Boolean

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

useOidc^Optional

• Type: java.lang.Boolean

(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.

Note: When using OIDC for authentication, use_microsoft_graph must be set to true (which is the default).

Methods

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)

path^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

• 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.

toMetadata

public java.lang.Object toMetadata()

toTerraform

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: software.constructs.Construct

name^Required

• Type: java.lang.String

_fromStack^Required

• Type: java.lang.String

Static Functions

isConstruct

import com.hashicorp.cdktf.AzurermBackend;

AzurermBackend.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.

x^Required

• Type: java.lang.Object

Any object.

isTerraformElement

import com.hashicorp.cdktf.AzurermBackend;

AzurermBackend.isTerraformElement(java.lang.Object x)

x^Required

• Type: java.lang.Object

isBackend

import com.hashicorp.cdktf.AzurermBackend;

AzurermBackend.isBackend(java.lang.Object x)

x^Required

• Type: java.lang.Object

Properties

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

cdktfStack^Required

public TerraformStack getCdktfStack();

• Type: TerraformStack

fqn^Required

public java.lang.String getFqn();

• Type: java.lang.String

friendlyUniqueId^Required

public java.lang.String getFriendlyUniqueId();

• Type: java.lang.String

CloudBackend

The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.

Initializers

import com.hashicorp.cdktf.CloudBackend;

CloudBackend.Builder.create(Construct scope)
    .organization(java.lang.String)
    .workspaces(NamedCloudWorkspace)
    .workspaces(TaggedCloudWorkspaces)
//  .hostname(java.lang.String)
//  .token(java.lang.String)
    .build();

scope^Required

• Type: software.constructs.Construct

organization^Required

• Type: java.lang.String

The name of the organization containing the workspace(s) the current configuration should use.

workspaces^Required

• Type: NamedCloudWorkspace OR TaggedCloudWorkspaces

A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.

The workspaces block must contain exactly one of the following arguments, each denoting a strategy for how workspaces should be mapped:

hostname^Optional

• Type: java.lang.String
• Default: app.terraform.io

The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.

token^Optional

• Type: java.lang.String

The token used to authenticate with Terraform Cloud.

We recommend omitting the token from the configuration, and instead using terraform login or manually configuring credentials in the CLI config file.

Methods

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)

path^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

• 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.

toMetadata

public java.lang.Object toMetadata()

toTerraform

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: software.constructs.Construct

name^Required

• Type: java.lang.String

_fromStack^Required

• Type: java.lang.String

Static Functions

isConstruct

import com.hashicorp.cdktf.CloudBackend;

CloudBackend.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.

x^Required

• Type: java.lang.Object

Any object.

isTerraformElement

import com.hashicorp.cdktf.CloudBackend;

CloudBackend.isTerraformElement(java.lang.Object x)

x^Required

• Type: java.lang.Object

isBackend

import com.hashicorp.cdktf.CloudBackend;

CloudBackend.isBackend(java.lang.Object x)

x^Required

• Type: java.lang.Object

Properties

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

cdktfStack^Required

public TerraformStack getCdktfStack();

• Type: TerraformStack

fqn^Required

public java.lang.String getFqn();

• Type: java.lang.String

friendlyUniqueId^Required

public java.lang.String getFriendlyUniqueId();

• Type: java.lang.String

ConsulBackend

Initializers

import com.hashicorp.cdktf.ConsulBackend;

ConsulBackend.Builder.create(Construct scope)
    .accessToken(java.lang.String)
    .path(java.lang.String)
//  .address(java.lang.String)
//  .caFile(java.lang.String)
//  .certFile(java.lang.String)
//  .datacenter(java.lang.String)
//  .gzip(java.lang.Boolean)
//  .httpAuth(java.lang.String)
//  .keyFile(java.lang.String)
//  .lock(java.lang.Boolean)
//  .scheme(java.lang.String)
    .build();

scope^Required

• Type: software.constructs.Construct

accessToken^Required

• Type: java.lang.String

(Required) Access token.

path^Required

• Type: java.lang.String

(Required) Path in the Consul KV store.

address^Optional

• Type: java.lang.String

(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.

Defaults to the local agent HTTP listener.

caFile^Optional

• Type: java.lang.String

(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.

certFile^Optional

• Type: java.lang.String

(Optional) A path to a PEM-encoded certificate provided to the remote agent;

requires use of key_file.

datacenter^Optional

• Type: java.lang.String

(Optional) The datacenter to use.

Defaults to that of the agent.

gzip^Optional

• Type: java.lang.Boolean

(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.

httpAuth^Optional

• Type: java.lang.String

(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.

keyFile^Optional

• Type: java.lang.String

(Optional) A path to a PEM-encoded private key, required if cert_file is specified.

lock^Optional

• Type: java.lang.Boolean

(Optional) false to disable locking.

This defaults to true, but will require session permissions with Consul and at least kv write permissions on $path/.lock to perform locking.

scheme^Optional

• Type: java.lang.String

(Optional) Specifies what protocol to use when talking to the given address,either http or https.

SSL support can also be triggered by setting then environment variable CONSUL_HTTP_SSL to true.

Methods

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)

path^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

• 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.

toMetadata

public java.lang.Object toMetadata()

toTerraform

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: software.constructs.Construct

name^Required

• Type: java.lang.String

_fromStack^Required

• Type: java.lang.String

Static Functions

isConstruct

import com.hashicorp.cdktf.ConsulBackend;

ConsulBackend.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.

x^Required

• Type: java.lang.Object

Any object.

isTerraformElement

import com.hashicorp.cdktf.ConsulBackend;

ConsulBackend.isTerraformElement(java.lang.Object x)

x^Required

• Type: java.lang.Object

isBackend

import com.hashicorp.cdktf.ConsulBackend;

ConsulBackend.isBackend(java.lang.Object x)

x^Required

• Type: java.lang.Object

Properties

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

cdktfStack^Required

public TerraformStack getCdktfStack();

• Type: TerraformStack

fqn^Required

public java.lang.String getFqn();

• Type: java.lang.String

friendlyUniqueId^Required

public java.lang.String getFriendlyUniqueId();

• Type: java.lang.String

CosBackend

Initializers

import com.hashicorp.cdktf.CosBackend;

CosBackend.Builder.create(Construct scope)
    .bucket(java.lang.String)
//  .acl(java.lang.String)
//  .encrypt(java.lang.Boolean)
//  .key(java.lang.String)
//  .prefix(java.lang.String)
//  .region(java.lang.String)
//  .secretId(java.lang.String)
//  .secretKey(java.lang.String)
    .build();

scope^Required

• Type: software.constructs.Construct

bucket^Required

• Type: java.lang.String

(Required) The name of the COS bucket.

You shall manually create it first.

acl^Optional

• Type: java.lang.String

(Optional) Object ACL to be applied to the state file, allows private and public-read.

Defaults to private.

encrypt^Optional

• Type: java.lang.Boolean

(Optional) Whether to enable server side encryption of the state file.

If it is true, COS will use 'AES256' encryption algorithm to encrypt state file.

key^Optional

• Type: java.lang.String

(Optional) The path for saving the state file in bucket.

Defaults to terraform.tfstate.

prefix^Optional

• Type: java.lang.String

(Optional) The directory for saving the state file in bucket.

Default to "env:".

region^Optional

• Type: java.lang.String

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

secretId^Optional

• Type: java.lang.String

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

secretKey^Optional

• Type: java.lang.String

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

Methods

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)

path^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

• 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.

toMetadata

public java.lang.Object toMetadata()

toTerraform

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

getRemoteStateDataSource

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)

Creates a TerraformRemoteState resource that accesses this backend.

scope^Required

• Type: software.constructs.Construct

name^Required

• Type: java.lang.String

_fromStack^Required

• Type: java.lang.String

Static Functions

isConstruct

import com.hashicorp.cdktf.CosBackend;

CosBackend.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.

x^Required

• Type: java.lang.Object

Any object.

isTerraformElement

import com.hashicorp.cdktf.CosBackend;

CosBackend.isTerraformElement(java.lang.Object x)

x^Required

• Type: java.lang.Object

isBackend

import com.hashicorp.cdktf.CosBackend;

CosBackend.isBackend(java.lang.Object x)

x^Required

• Type: java.lang.Object

Properties

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

cdktfStack^Required

public TerraformStack getCdktfStack();

• Type: TerraformStack

fqn^Required

public java.lang.String getFqn();

• Type: java.lang.String

friendlyUniqueId^Required

public java.lang.String getFriendlyUniqueId();

• Type: java.lang.String

DataTerraformRemoteState

Initializers

import com.hashicorp.cdktf.DataTerraformRemoteState;

DataTerraformRemoteState.Builder.create(Construct scope, java.lang.String id)
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .organization(java.lang.String)
    .workspaces(IRemoteWorkspace)
//  .hostname(java.lang.String)
//  .token(java.lang.String)
    .build();

scope^Required

• Type: software.constructs.Construct

id^Required

• Type: java.lang.String

defaults^Optional

• Type: java.util.Map< java.lang.String, java.lang.Object >

workspace^Optional

• Type: java.lang.String

organization^Required

• Type: java.lang.String

workspaces^Required

• Type: IRemoteWorkspace

hostname^Optional

• Type: java.lang.String

token^Optional

• Type: java.lang.String

Methods

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)

path^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

overrideLogicalId

public void overrideLogicalId(java.lang.String newLogicalId)

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

newLogicalId^Required

• 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.

toMetadata

public java.lang.Object toMetadata()

toTerraform

public java.lang.Object toTerraform()

Adds this resource to the terraform JSON output.

get

public IResolvable get(java.lang.String output)

output^Required

• Type: java.lang.String

getBoolean

public IResolvable getBoolean(java.lang.String output)

output^Required

• Type: java.lang.String

getList

public java.util.List< java.lang.String > getList(java.lang.String output)

output^Required

• Type: java.lang.String

getNumber

public java.lang.Number getNumber(java.lang.String output)

output^Required

• Type: java.lang.String

getString

public java.lang.String getString(java.lang.String output)

output^Required

• Type: java.lang.String

Static Functions

isConstruct

import com.hashicorp.cdktf.DataTerraformRemoteState;

DataTerraformRemoteState.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.

x^Required

• Type: java.lang.Object

Any object.

isTerraformElement

import com.hashicorp.cdktf.DataTerraformRemoteState;

DataTerraformRemoteState.isTerraformElement(java.lang.Object x)

x^Required

• Type: java.lang.Object

Properties

node^Required

public Node getNode();

• Type: software.constructs.Node

The tree node.

cdktfStack^Required

public TerraformStack getCdktfStack();

• Type: TerraformStack

fqn^Required

public java.lang.String getFqn();

• Type: java.lang.String

friendlyUniqueId^Required

public java.lang.String getFriendlyUniqueId();

• Type: java.lang.String

Constants

tfResourceType^Required

public java.lang.String getTfResourceType();

• Type: java.lang.String

DataTerraformRemoteStateArtifactory

Initializers

import com.hashicorp.cdktf.DataTerraformRemoteStateArtifactory;

DataTerraformRemoteStateArtifactory.Builder.create(Construct scope, java.lang.String id)
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .password(java.lang.String)
    .repo(java.lang.String)
    .subpath(java.lang.String)
    .url(java.lang.String)
    .username(java.lang.String)
    .build();

scope^Required

• Type: software.constructs.Construct

id^Required

• Type: java.lang.String

defaults^Optional

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.util.Map< java.lang.String, java.lang.Object >

workspace^Optional

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

password^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The password.

repo^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The repository name.

subpath^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - Path within the repository.

url^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The URL.

Note that this is the base url to artifactory not the full repo and subpath.

username^Required

• Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.

• Type: java.lang.String

(Required) - The username.

Methods