Typescript: Structs

AppConfig

Initializer

import { AppConfig } from 'cdktf'

const appConfig: AppConfig = { ... }

Properties

context^Optional

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

• Type: {[ key: string ]: any}
• 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).

hclOutput^Optional

public readonly hclOutput: boolean;

• Type: boolean

outdir^Optional

public readonly outdir: string;

• Type: string
• Default: CDKTF_OUTDIR if defined, otherwise "cdktf.out"

The directory to output Terraform resources.

If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:

• The -o / --output CLI option
• The CDKTF_OUTDIR environment variable
• The outdir key in cdktf.json

If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.

The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).

skipBackendValidation^Optional

public readonly skipBackendValidation: boolean;

• Type: boolean
• Default: false

Whether to skip backend validation during synthesis of the app.

skipValidation^Optional

public readonly skipValidation: boolean;

• Type: boolean
• Default: false

Whether to skip all validations during synthesis of the app.

stackTraces^Optional

public readonly stackTraces: boolean;

• Type: boolean

AzurermBackendConfig

Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account.

This backend supports state locking and consistency checking with Azure Blob Storage native capabilities.

Note: By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting use_microsoft_graph to true. The default for this will change in Terraform 1.2, so that MSAL authentication is used by default.

Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/azurerm

Initializer

import { AzurermBackendConfig } from 'cdktf'

const azurermBackendConfig: AzurermBackendConfig = { ... }

Properties

containerName^Required

public readonly containerName: string;

• Type: string

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

key^Required

public readonly key: string;

• Type: string

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

storageAccountName^Required

public readonly storageAccountName: string;

• Type: string

(Required) The Name of the Storage Account.

accessKey^Optional

public readonly accessKey: string;

• Type: 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

public readonly clientCertificatePassword: string;

• Type: 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

public readonly clientCertificatePath: string;

• Type: 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

public readonly clientId: string;

• Type: string

(Optional) The Client ID of the Service Principal.

This can also be sourced from the ARM_CLIENT_ID environment variable.

clientSecret^Optional

public readonly clientSecret: string;

• Type: string

(Optional) The Client Secret of the Service Principal.

This can also be sourced from the ARM_CLIENT_SECRET environment variable.

endpoint^Optional

public readonly endpoint: string;

• Type: 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

public readonly environment: string;

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

metadataHost^Optional

public readonly metadataHost: string;

• Type: string

(Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.).

msiEndpoint^Optional

public readonly msiEndpoint: string;

• Type: 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

public readonly oidcRequestToken: string;

• Type: 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

public readonly oidcRequestUrl: string;

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

oidcToken^Optional

public readonly oidcToken: string;

• Type: string

(Optional) The ID token when authenticating using OpenID Connect (OIDC).

This can also be sourced from the ARM_OIDC_TOKEN environment variable.

oidcTokenFilePath^Optional

public readonly oidcTokenFilePath: string;

• Type: string

(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC).

This can also be sourced from the ARM_OIDC_TOKEN_FILE_PATH environment variable.

resourceGroupName^Optional

public readonly resourceGroupName: string;

• Type: string

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

sasToken^Optional

public readonly sasToken: string;

• Type: 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

public readonly snapshot: boolean;

• Type: 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

public readonly subscriptionId: string;

• Type: 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

public readonly tenantId: string;

• Type: string

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

This can also be sourced from the ARM_TENANT_ID environment variable.

useAzureadAuth^Optional

public readonly useAzureadAuth: boolean;

• Type: 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

public readonly useMicrosoftGraph: boolean;

• Type: 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

public readonly useMsi: boolean;

• Type: boolean

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

useOidc^Optional

public readonly useOidc: boolean;

• Type: 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).

CloudBackendConfig

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.

https://developer.hashicorp.com/terraform/cli/cloud/settings#arguments

Initializer

import { CloudBackendConfig } from 'cdktf'

const cloudBackendConfig: CloudBackendConfig = { ... }

Properties

organization^Required

public readonly organization: string;

• Type: string

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

workspaces^Required

public readonly workspaces: NamedCloudWorkspace | TaggedCloudWorkspaces;

• Type: NamedCloudWorkspace | 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

public readonly hostname: string;

• Type: string
• Default: app.terraform.io

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

token^Optional

public readonly token: string;

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

ConsulBackendConfig

Stores the state in the Consul KV store at a given path. This backend supports state locking.

Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/consul

Initializer

import { ConsulBackendConfig } from 'cdktf'

const consulBackendConfig: ConsulBackendConfig = { ... }

Properties

accessToken^Required

public readonly accessToken: string;

• Type: string

(Required) Access token.

path^Required

public readonly path: string;

• Type: string

(Required) Path in the Consul KV store.

address^Optional

public readonly address: string;

• Type: 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

public readonly caFile: string;

• Type: string

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

certFile^Optional

public readonly certFile: string;

• Type: string

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

requires use of key_file.

datacenter^Optional

public readonly datacenter: string;

• Type: string

(Optional) The datacenter to use.

Defaults to that of the agent.

gzip^Optional

public readonly gzip: boolean;

• Type: boolean

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

httpAuth^Optional

public readonly httpAuth: string;

• Type: string

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

keyFile^Optional

public readonly keyFile: string;

• Type: string

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

lock^Optional

public readonly lock: boolean;

• Type: 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

public readonly scheme: string;

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

CosBackendAssumeRole

Initializer

import { CosBackendAssumeRole } from 'cdktf'

const cosBackendAssumeRole: CosBackendAssumeRole = { ... }

Properties

roleArn^Required

public readonly roleArn: string;

• Type: string

(Required) The ARN of the role to assume.

It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_ARN.

sessionDuration^Required

public readonly sessionDuration: number;

• Type: number

(Required) The duration of the session when making the AssumeRole call.

Its value ranges from 0 to 43200(seconds), and default is 7200 seconds. It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION.

sessionName^Required

public readonly sessionName: string;

• Type: string

(Required) The session name to use when making the AssumeRole call.

It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME.

policy^Optional

public readonly policy: any;

• Type: any

(Optional) A more restrictive policy when making the AssumeRole call.

Its content must not contains principal elements. Please refer to {@link https://www.tencentcloud.com/document/product/598/10603 policies syntax logic}.

CosBackendConfig

Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS).

This backend supports state locking.

Warning! It is highly recommended that you enable Object Versioning on the COS bucket to allow for state recovery in the case of accidental deletions and human error.

Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/cos

Initializer

import { CosBackendConfig } from 'cdktf'

const cosBackendConfig: CosBackendConfig = { ... }

Properties

bucket^Required

public readonly bucket: string;

• Type: string

(Required) The name of the COS bucket.

You shall manually create it first.

accelerate^Optional

public readonly accelerate: boolean;

• Type: boolean

(Optional) Whether to enable global Acceleration.

Defaults to false.

acl^Optional

public readonly acl: string;

• Type: string

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

Defaults to private.

assumeRole^Optional

public readonly assumeRole: CosBackendAssumeRole;

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

If provided, terraform will attempt to assume this role using the supplied credentials.

domain^Optional

public readonly domain: string;

• Type: string

(Optional) The root domain of the API request.

Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.

encrypt^Optional

public readonly encrypt: boolean;

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

endpoint^Optional

public readonly endpoint: string;

• Type: string

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

key^Optional

public readonly key: string;

• Type: string

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

Defaults to terraform.tfstate.

prefix^Optional

public readonly prefix: string;

• Type: string

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

Default to "env:".

region^Optional

public readonly region: string;

• Type: string

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

secretId^Optional

public readonly secretId: string;

• Type: string

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

secretKey^Optional

public readonly secretKey: string;

• Type: string

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

securityToken^Optional

public readonly securityToken: string;

• Type: string

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

DataConfig

Initializer

import { DataConfig } from 'cdktf'

const dataConfig: DataConfig = { ... }

Properties

connection^Optional

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;

• Type: SSHProvisionerConnection | WinrmProvisionerConnection

count^Optional

public readonly count: number | TerraformCount;

• Type: number | TerraformCount

dependsOn^Optional

public readonly dependsOn: ITerraformDependable[];

• Type: ITerraformDependable[]

forEach^Optional

public readonly forEach: ITerraformIterator;

• Type: ITerraformIterator

lifecycle^Optional

public readonly lifecycle: TerraformResourceLifecycle;

• Type: TerraformResourceLifecycle

provider^Optional

public readonly provider: TerraformProvider;

• Type: TerraformProvider

provisioners^Optional

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

• Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]

input^Optional

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

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

(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.

https://developer.hashicorp.com/terraform/language/resources/terraform-data#input

triggersReplace^Optional

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

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

(Optional) A value which is stored in the instance state, and will force replacement when the value changes.

https://developer.hashicorp.com/terraform/language/resources/terraform-data#triggers_replace

DataTerraformRemoteStateAzurermConfig

Initializer

import { DataTerraformRemoteStateAzurermConfig } from 'cdktf'

const dataTerraformRemoteStateAzurermConfig: DataTerraformRemoteStateAzurermConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

containerName^Required

public readonly containerName: string;

• Type: string

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

key^Required

public readonly key: string;

• Type: string

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

storageAccountName^Required

public readonly storageAccountName: string;

• Type: string

(Required) The Name of the Storage Account.

accessKey^Optional

public readonly accessKey: string;

• Type: 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

public readonly clientCertificatePassword: string;

• Type: 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

public readonly clientCertificatePath: string;

• Type: 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

public readonly clientId: string;

• Type: string

(Optional) The Client ID of the Service Principal.

This can also be sourced from the ARM_CLIENT_ID environment variable.

clientSecret^Optional

public readonly clientSecret: string;

• Type: string

(Optional) The Client Secret of the Service Principal.

This can also be sourced from the ARM_CLIENT_SECRET environment variable.

endpoint^Optional

public readonly endpoint: string;

• Type: 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

public readonly environment: string;

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

metadataHost^Optional

public readonly metadataHost: string;

• Type: string

(Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.).

msiEndpoint^Optional

public readonly msiEndpoint: string;

• Type: 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

public readonly oidcRequestToken: string;

• Type: 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

public readonly oidcRequestUrl: string;

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

oidcToken^Optional

public readonly oidcToken: string;

• Type: string

(Optional) The ID token when authenticating using OpenID Connect (OIDC).

This can also be sourced from the ARM_OIDC_TOKEN environment variable.

oidcTokenFilePath^Optional

public readonly oidcTokenFilePath: string;

• Type: string

(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC).

This can also be sourced from the ARM_OIDC_TOKEN_FILE_PATH environment variable.

resourceGroupName^Optional

public readonly resourceGroupName: string;

• Type: string

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

sasToken^Optional

public readonly sasToken: string;

• Type: 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

public readonly snapshot: boolean;

• Type: 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

public readonly subscriptionId: string;

• Type: 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

public readonly tenantId: string;

• Type: string

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

This can also be sourced from the ARM_TENANT_ID environment variable.

useAzureadAuth^Optional

public readonly useAzureadAuth: boolean;

• Type: 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

public readonly useMicrosoftGraph: boolean;

• Type: 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

public readonly useMsi: boolean;

• Type: boolean

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

useOidc^Optional

public readonly useOidc: boolean;

• Type: 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).

DataTerraformRemoteStateConfig

Initializer

import { DataTerraformRemoteStateConfig } from 'cdktf'

const dataTerraformRemoteStateConfig: DataTerraformRemoteStateConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

DataTerraformRemoteStateConsulConfig

Initializer

import { DataTerraformRemoteStateConsulConfig } from 'cdktf'

const dataTerraformRemoteStateConsulConfig: DataTerraformRemoteStateConsulConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

accessToken^Required

public readonly accessToken: string;

• Type: string

(Required) Access token.

path^Required

public readonly path: string;

• Type: string

(Required) Path in the Consul KV store.

address^Optional

public readonly address: string;

• Type: 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

public readonly caFile: string;

• Type: string

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

certFile^Optional

public readonly certFile: string;

• Type: string

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

requires use of key_file.

datacenter^Optional

public readonly datacenter: string;

• Type: string

(Optional) The datacenter to use.

Defaults to that of the agent.

gzip^Optional

public readonly gzip: boolean;

• Type: boolean

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

httpAuth^Optional

public readonly httpAuth: string;

• Type: string

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

keyFile^Optional

public readonly keyFile: string;

• Type: string

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

lock^Optional

public readonly lock: boolean;

• Type: 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

public readonly scheme: string;

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

DataTerraformRemoteStateCosConfig

Initializer

import { DataTerraformRemoteStateCosConfig } from 'cdktf'

const dataTerraformRemoteStateCosConfig: DataTerraformRemoteStateCosConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

bucket^Required

public readonly bucket: string;

• Type: string

(Required) The name of the COS bucket.

You shall manually create it first.

accelerate^Optional

public readonly accelerate: boolean;

• Type: boolean

(Optional) Whether to enable global Acceleration.

Defaults to false.

acl^Optional

public readonly acl: string;

• Type: string

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

Defaults to private.

assumeRole^Optional

public readonly assumeRole: CosBackendAssumeRole;

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

If provided, terraform will attempt to assume this role using the supplied credentials.

domain^Optional

public readonly domain: string;

• Type: string

(Optional) The root domain of the API request.

Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.

encrypt^Optional

public readonly encrypt: boolean;

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

endpoint^Optional

public readonly endpoint: string;

• Type: string

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

key^Optional

public readonly key: string;

• Type: string

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

Defaults to terraform.tfstate.

prefix^Optional

public readonly prefix: string;

• Type: string

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

Default to "env:".

region^Optional

public readonly region: string;

• Type: string

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

secretId^Optional

public readonly secretId: string;

• Type: string

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

secretKey^Optional

public readonly secretKey: string;

• Type: string

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

securityToken^Optional

public readonly securityToken: string;

• Type: string

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

DataTerraformRemoteStateGcsConfig

Initializer

import { DataTerraformRemoteStateGcsConfig } from 'cdktf'

const dataTerraformRemoteStateGcsConfig: DataTerraformRemoteStateGcsConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

bucket^Required

public readonly bucket: string;

• Type: string

(Required) The name of the GCS bucket.

This name must be globally unique.

accessToken^Optional

public readonly accessToken: string;

• Type: string

(Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access_token will be used over the credentials field.

credentials^Optional

public readonly credentials: string;

• Type: string

(Optional) Local path to Google Cloud Platform account credentials in JSON format.

If unset, Google Application Default Credentials are used. The provided credentials must have Storage Object Admin role on the bucket.

Warning: if using the Google Cloud Platform provider as well, it will also pick up the GOOGLE_CREDENTIALS environment variable.

encryptionKey^Optional

public readonly encryptionKey: string;

• Type: string

(Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.

impersonateServiceAccount^Optional

public readonly impersonateServiceAccount: string;

• Type: string

(Optional) The service account to impersonate for accessing the State Bucket.

You must have roles/iam.serviceAccountTokenCreator role on that account for the impersonation to succeed. If you are using a delegation chain, you can specify that using the impersonate_service_account_delegates field. Alternatively, this can be specified using the GOOGLE_IMPERSONATE_SERVICE_ACCOUNT environment variable.

impersonateServiceAccountDelegates^Optional

public readonly impersonateServiceAccountDelegates: string[];

• Type: string[]

(Optional) The delegation chain for an impersonating a service account.

kmsEncryptionKey^Optional

public readonly kmsEncryptionKey: string;

• Type: string

(Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket.

Format should be projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{name}}. For more information, including IAM requirements, see {@link https://cloud.google.com/storage/docs/encryption/customer-managed-keys Customer-managed Encryption Keys}.

prefix^Optional

public readonly prefix: string;

• Type: string

(Optional) GCS prefix inside the bucket.

Named states for workspaces are stored in an object called < prefix >/< name >.tfstate.

storeageCustomEndpoint^Optional

public readonly storeageCustomEndpoint: string;

• Type: string

(Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b).

{@link https://developer.hashicorp.com/terraform/language/settings/backends/gcs#storage_custom_endpoint See here for more details}

DataTerraformRemoteStateHttpConfig

Initializer

import { DataTerraformRemoteStateHttpConfig } from 'cdktf'

const dataTerraformRemoteStateHttpConfig: DataTerraformRemoteStateHttpConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

address^Required

public readonly address: string;

• Type: string

(Required) The address of the REST endpoint.

clientCaCertificatePem^Optional

public readonly clientCaCertificatePem: string;

• Type: string

(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.

clientCertificatePem^Optional

public readonly clientCertificatePem: string;

• Type: string

(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.

clientPrivateKeyPem^Optional

public readonly clientPrivateKeyPem: string;

• Type: string

(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.

lockAddress^Optional

public readonly lockAddress: string;

• Type: string

(Optional) The address of the lock REST endpoint.

Defaults to disabled.

lockMethod^Optional

public readonly lockMethod: string;

• Type: string

(Optional) The HTTP method to use when locking.

Defaults to LOCK.

password^Optional

public readonly password: string;

• Type: string

(Optional) The password for HTTP basic authentication.

retryMax^Optional

public readonly retryMax: number;

• Type: number

(Optional) The number of HTTP request retries.

Defaults to 2.

retryWaitMax^Optional

public readonly retryWaitMax: number;

• Type: number

(Optional) The maximum time in seconds to wait between HTTP request attempts.

Defaults to 30.

retryWaitMin^Optional

public readonly retryWaitMin: number;

• Type: number

(Optional) The minimum time in seconds to wait between HTTP request attempts.

Defaults to 1.

skipCertVerification^Optional

public readonly skipCertVerification: boolean;

• Type: boolean

(Optional) Whether to skip TLS verification.

Defaults to false.

unlockAddress^Optional

public readonly unlockAddress: string;

• Type: string

(Optional) The address of the unlock REST endpoint.

Defaults to disabled.

unlockMethod^Optional

public readonly unlockMethod: string;

• Type: string

(Optional) The HTTP method to use when unlocking.

Defaults to UNLOCK.

updateMethod^Optional

public readonly updateMethod: string;

• Type: string

(Optional) HTTP method to use when updating state.

Defaults to POST.

username^Optional

public readonly username: string;

• Type: string

(Optional) The username for HTTP basic authentication.

DataTerraformRemoteStateLocalConfig

Initializer

import { DataTerraformRemoteStateLocalConfig } from 'cdktf'

const dataTerraformRemoteStateLocalConfig: DataTerraformRemoteStateLocalConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

path^Optional

public readonly path: string;

• Type: string
• Default: defaults to terraform.${stackId}.tfstate

Path where the state file is stored.

workspaceDir^Optional

public readonly workspaceDir: string;

• Type: string

(Optional) The path to non-default workspaces.

DataTerraformRemoteStateOssConfig

Initializer

import { DataTerraformRemoteStateOssConfig } from 'cdktf'

const dataTerraformRemoteStateOssConfig: DataTerraformRemoteStateOssConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

bucket^Required

public readonly bucket: string;

• Type: string

(Required) The name of the OSS bucket.

accessKey^Optional

public readonly accessKey: string;

• Type: string

(Optional) Alibaba Cloud access key.

It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

acl^Optional

public readonly acl: string;

• Type: string

(Optional) Object ACL to be applied to the state file.

assumeRole^Optional

• Deprecated: Use flattened assume role options

public readonly assumeRole: OssAssumeRole;

• Type: OssAssumeRole

assumeRolePolicy^Optional

public readonly assumeRolePolicy: string;

• Type: string

(Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.

assumeRoleRoleArn^Optional

public readonly assumeRoleRoleArn: string;

• Type: string

(Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials.

assumeRoleSessionExpiration^Optional

public readonly assumeRoleSessionExpiration: number;

• Type: number

(Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.

assumeRoleSessionName^Optional

public readonly assumeRoleSessionName: string;

• Type: string

(Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME.

ecsRoleName^Optional

public readonly ecsRoleName: string;

• Type: string

(Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.

encrypt^Optional

public readonly encrypt: boolean;

• Type: boolean

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

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

endpoint^Optional

public readonly endpoint: string;

• Type: string

(Optional) A custom endpoint for the OSS API.

It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

key^Optional

public readonly key: string;

• Type: string

(Optional) The name of the state file.

Defaults to terraform.tfstate.

prefix^Optional

public readonly prefix: string;

• Type: string

(Optional) The path directory of the state file will be stored.

Default to "env:".

profile^Optional

public readonly profile: string;

• Type: string

(Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable.

region^Optional

public readonly region: string;

• Type: string

(Optional) The region of the OSS bucket.

It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

secretKey^Optional

public readonly secretKey: string;

• Type: string

(Optional) Alibaba Cloud secret access key.

It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

securityToken^Optional

public readonly securityToken: string;

• Type: string

(Optional) STS access token.

It supports environment variable ALICLOUD_SECURITY_TOKEN.

sharedCredentialsFile^Optional

public readonly sharedCredentialsFile: string;

• Type: string

(Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used.

stsEndpoint^Optional

public readonly stsEndpoint: string;

• Type: string

(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.

tablestoreEndpoint^Optional

public readonly tablestoreEndpoint: string;

• Type: string

(Optional) A custom endpoint for the TableStore API.

tablestoreTable^Optional

public readonly tablestoreTable: string;

• Type: string

(Optional) A TableStore table for state locking and consistency.

The table must have a primary key named LockID of type String.

DataTerraformRemoteStatePgConfig

Initializer

import { DataTerraformRemoteStatePgConfig } from 'cdktf'

const dataTerraformRemoteStatePgConfig: DataTerraformRemoteStatePgConfig = { ... }

Properties

defaults^Optional

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

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

workspace^Optional

public readonly workspace: string;

• Type: string

connStr^Required

public readonly connStr: string;

• Type: string

Postgres connection string;

a postgres:// URL. The PG_CONN_STR and standard libpq environment variables can also be used to indicate how to connect to the PostgreSQL database.

schemaName^Optional

public readonly schemaName: string;

• Type: string

Name of the automatically-managed Postgres schema, default to terraform_remote_state.

Can also be set using the PG_SCHEMA_NAME environment variable.

skipIndexCreation^Optional

public readonly skipIndexCreation: boolean;

• Type: boolean

If set to true, the Postgres index must already exist.

Can also be set using the PG_SKIP_INDEX_CREATION environment variable. Terraform won't try to create the index, this is useful when it has already been created by a database administrator.

skipSchemaCreation^Optional

public readonly skipSchemaCreation: boolean;

• Type: boolean

If set to true, the Postgres schema must already exist.

Can also be set using the PG_SKIP_SCHEMA_CREATION environment variable. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator.

skipTableCreation^Optional

public readonly skipTableCreation: boolean;

• Type: boolean

If set to true, the Postgres table must already exist.

Can also be set using the PG_SKIP_TABLE_CREATION environment variable. Terraform won't try to create the table, this is useful when it has already been created by a database administrator.

DataTerraformRemoteStateRemoteConfig

Initializer

import { DataTerraformRemoteStateRemoteConfig } from 'cdktf'

const dataTerraformRemoteStateRemoteConfig: DataTerraformRemoteStateRemoteConfig = { ... }

Properties