Java: Structs

AppConfig

Initializer

import com.hashicorp.cdktf.AppConfig;

AppConfig.builder()
//  .context(java.util.Map< java.lang.String, java.lang.Object >)
//  .hclOutput(java.lang.Boolean)
//  .outdir(java.lang.String)
//  .skipBackendValidation(java.lang.Boolean)
//  .skipValidation(java.lang.Boolean)
//  .stackTraces(java.lang.Boolean)
    .build();

Properties

context^Optional

public java.util.Map< java.lang.String, java.lang.Object > getContext();

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

hclOutput^Optional

public java.lang.Boolean getHclOutput();

• Type: java.lang.Boolean

outdir^Optional

public java.lang.String getOutdir();

• Type: java.lang.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 java.lang.Boolean getSkipBackendValidation();

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

Whether to skip backend validation during synthesis of the app.

skipValidation^Optional

public java.lang.Boolean getSkipValidation();

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

Whether to skip all validations during synthesis of the app.

stackTraces^Optional

public java.lang.Boolean getStackTraces();

• Type: java.lang.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 com.hashicorp.cdktf.AzurermBackendConfig;

AzurermBackendConfig.builder()
    .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)
//  .metadataHost(java.lang.String)
//  .msiEndpoint(java.lang.String)
//  .oidcRequestToken(java.lang.String)
//  .oidcRequestUrl(java.lang.String)
//  .oidcToken(java.lang.String)
//  .oidcTokenFilePath(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();

Properties

containerName^Required

public java.lang.String getContainerName();

• Type: java.lang.String

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

key^Required

public java.lang.String getKey();

• Type: java.lang.String

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

storageAccountName^Required

public java.lang.String getStorageAccountName();

• Type: java.lang.String

(Required) The Name of the Storage Account.

accessKey^Optional

public java.lang.String getAccessKey();

• 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

public java.lang.String getClientCertificatePassword();

• 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

public java.lang.String getClientCertificatePath();

• 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

public java.lang.String getClientId();

• 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

public java.lang.String getClientSecret();

• 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

public java.lang.String getEndpoint();

• 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

public java.lang.String getEnvironment();

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

metadataHost^Optional

public java.lang.String getMetadataHost();

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

• 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

public java.lang.String getOidcRequestToken();

• 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

public java.lang.String getOidcRequestUrl();

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

oidcToken^Optional

public java.lang.String getOidcToken();

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

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

• Type: java.lang.String

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

sasToken^Optional

public java.lang.String getSasToken();

• 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

public java.lang.Boolean getSnapshot();

• 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

public java.lang.String getSubscriptionId();

• 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

public java.lang.String getTenantId();

• 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

public java.lang.Boolean getUseAzureadAuth();

• 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

public java.lang.Boolean getUseMicrosoftGraph();

• 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

public java.lang.Boolean getUseMsi();

• 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

public java.lang.Boolean getUseOidc();

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

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 com.hashicorp.cdktf.CloudBackendConfig;

CloudBackendConfig.builder()
    .organization(java.lang.String)
    .workspaces(NamedCloudWorkspace)
    .workspaces(TaggedCloudWorkspaces)
//  .hostname(java.lang.String)
//  .token(java.lang.String)
    .build();

Properties

organization^Required

public java.lang.String getOrganization();

• Type: java.lang.String

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

workspaces^Required

public java.lang.Object getWorkspaces();

• 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

public java.lang.String getHostname();

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

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

token^Optional

public java.lang.String getToken();

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

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 com.hashicorp.cdktf.ConsulBackendConfig;

ConsulBackendConfig.builder()
    .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();

Properties

accessToken^Required

public java.lang.String getAccessToken();

• Type: java.lang.String

(Required) Access token.

path^Required

public java.lang.String getPath();

• Type: java.lang.String

(Required) Path in the Consul KV store.

address^Optional

public java.lang.String getAddress();

• 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

public java.lang.String getCaFile();

• Type: java.lang.String

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

certFile^Optional

public java.lang.String getCertFile();

• Type: java.lang.String

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

requires use of key_file.

datacenter^Optional

public java.lang.String getDatacenter();

• Type: java.lang.String

(Optional) The datacenter to use.

Defaults to that of the agent.

gzip^Optional

public java.lang.Boolean getGzip();

• Type: java.lang.Boolean

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

httpAuth^Optional

public java.lang.String getHttpAuth();

• 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

public java.lang.String getKeyFile();

• Type: java.lang.String

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

lock^Optional

public java.lang.Boolean getLock();

• 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

public java.lang.String getScheme();

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

CosBackendAssumeRole

Initializer

import com.hashicorp.cdktf.CosBackendAssumeRole;

CosBackendAssumeRole.builder()
    .roleArn(java.lang.String)
    .sessionDuration(java.lang.Number)
    .sessionName(java.lang.String)
//  .policy(java.lang.Object)
    .build();

Properties

roleArn^Required

public java.lang.String getRoleArn();

• Type: java.lang.String

(Required) The ARN of the role to assume.

It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_ARN.

sessionDuration^Required

public java.lang.Number getSessionDuration();

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

• Type: java.lang.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 java.lang.Object getPolicy();

• Type: java.lang.Object

(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 com.hashicorp.cdktf.CosBackendConfig;

CosBackendConfig.builder()
    .bucket(java.lang.String)
//  .accelerate(java.lang.Boolean)
//  .acl(java.lang.String)
//  .assumeRole(CosBackendAssumeRole)
//  .domain(java.lang.String)
//  .encrypt(java.lang.Boolean)
//  .endpoint(java.lang.String)
//  .key(java.lang.String)
//  .prefix(java.lang.String)
//  .region(java.lang.String)
//  .secretId(java.lang.String)
//  .secretKey(java.lang.String)
//  .securityToken(java.lang.String)
    .build();

Properties

bucket^Required

public java.lang.String getBucket();

• Type: java.lang.String

(Required) The name of the COS bucket.

You shall manually create it first.

accelerate^Optional

public java.lang.Boolean getAccelerate();

• Type: java.lang.Boolean

(Optional) Whether to enable global Acceleration.

Defaults to false.

acl^Optional

public java.lang.String getAcl();

• Type: java.lang.String

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

Defaults to private.

assumeRole^Optional

public CosBackendAssumeRole getAssumeRole();

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

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

domain^Optional

public java.lang.String getDomain();

• Type: java.lang.String

(Optional) The root domain of the API request.

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

encrypt^Optional

public java.lang.Boolean getEncrypt();

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

endpoint^Optional

public java.lang.String getEndpoint();

• Type: java.lang.String

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

key^Optional

public java.lang.String getKey();

• Type: java.lang.String

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

Defaults to terraform.tfstate.

prefix^Optional

public java.lang.String getPrefix();

• Type: java.lang.String

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

Default to "env:".

region^Optional

public java.lang.String getRegion();

• Type: java.lang.String

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

secretId^Optional

public java.lang.String getSecretId();

• Type: java.lang.String

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

secretKey^Optional

public java.lang.String getSecretKey();

• Type: java.lang.String

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

securityToken^Optional

public java.lang.String getSecurityToken();

• Type: java.lang.String

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

DataConfig

Initializer

import com.hashicorp.cdktf.DataConfig;

DataConfig.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 >)
//  .input(java.util.Map< java.lang.String, java.lang.Object >)
//  .triggersReplace(java.util.Map< java.lang.String, java.lang.Object >)
    .build();

Properties

connection^Optional

public java.lang.Object getConnection();

• Type: SSHProvisionerConnection OR WinrmProvisionerConnection

count^Optional

public java.lang.Object getCount();

• Type: java.lang.Number OR TerraformCount

dependsOn^Optional

public java.util.List< ITerraformDependable > getDependsOn();

• Type: java.util.List< ITerraformDependable>

forEach^Optional

public ITerraformIterator getForEach();

• Type: ITerraformIterator

lifecycle^Optional

public TerraformResourceLifecycle getLifecycle();

• Type: TerraformResourceLifecycle

provider^Optional

public TerraformProvider getProvider();

• Type: TerraformProvider

provisioners^Optional

public java.lang.Object getProvisioners();

• Type: java.util.List< FileProvisioner OR LocalExecProvisioner OR RemoteExecProvisioner>

input^Optional

public java.util.Map< java.lang.String, java.lang.Object > getInput();

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

(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 java.util.Map< java.lang.String, java.lang.Object > getTriggersReplace();

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

(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 com.hashicorp.cdktf.DataTerraformRemoteStateAzurermConfig;

DataTerraformRemoteStateAzurermConfig.builder()
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .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)
//  .metadataHost(java.lang.String)
//  .msiEndpoint(java.lang.String)
//  .oidcRequestToken(java.lang.String)
//  .oidcRequestUrl(java.lang.String)
//  .oidcToken(java.lang.String)
//  .oidcTokenFilePath(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();

Properties

defaults^Optional

public java.util.Map< java.lang.String, java.lang.Object > getDefaults();

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

workspace^Optional

public java.lang.String getWorkspace();

• Type: java.lang.String

containerName^Required

public java.lang.String getContainerName();

• Type: java.lang.String

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

key^Required

public java.lang.String getKey();

• Type: java.lang.String

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

storageAccountName^Required

public java.lang.String getStorageAccountName();

• Type: java.lang.String

(Required) The Name of the Storage Account.

accessKey^Optional

public java.lang.String getAccessKey();

• 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

public java.lang.String getClientCertificatePassword();

• 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

public java.lang.String getClientCertificatePath();

• 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

public java.lang.String getClientId();

• 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

public java.lang.String getClientSecret();

• 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

public java.lang.String getEndpoint();

• 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

public java.lang.String getEnvironment();

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

metadataHost^Optional

public java.lang.String getMetadataHost();

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

• 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

public java.lang.String getOidcRequestToken();

• 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

public java.lang.String getOidcRequestUrl();

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

oidcToken^Optional

public java.lang.String getOidcToken();

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

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

• Type: java.lang.String

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

sasToken^Optional

public java.lang.String getSasToken();

• 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

public java.lang.Boolean getSnapshot();

• 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

public java.lang.String getSubscriptionId();

• 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

public java.lang.String getTenantId();

• 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

public java.lang.Boolean getUseAzureadAuth();

• 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

public java.lang.Boolean getUseMicrosoftGraph();

• 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

public java.lang.Boolean getUseMsi();

• 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

public java.lang.Boolean getUseOidc();

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

DataTerraformRemoteStateConfig

Initializer

import com.hashicorp.cdktf.DataTerraformRemoteStateConfig;

DataTerraformRemoteStateConfig.builder()
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .build();

Properties

defaults^Optional

public java.util.Map< java.lang.String, java.lang.Object > getDefaults();

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

workspace^Optional

public java.lang.String getWorkspace();

• Type: java.lang.String

DataTerraformRemoteStateConsulConfig

Initializer

import com.hashicorp.cdktf.DataTerraformRemoteStateConsulConfig;

DataTerraformRemoteStateConsulConfig.builder()
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .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();

Properties

defaults^Optional

public java.util.Map< java.lang.String, java.lang.Object > getDefaults();

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

workspace^Optional

public java.lang.String getWorkspace();

• Type: java.lang.String

accessToken^Required

public java.lang.String getAccessToken();

• Type: java.lang.String

(Required) Access token.

path^Required

public java.lang.String getPath();

• Type: java.lang.String

(Required) Path in the Consul KV store.

address^Optional

public java.lang.String getAddress();

• 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

public java.lang.String getCaFile();

• Type: java.lang.String

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

certFile^Optional

public java.lang.String getCertFile();

• Type: java.lang.String

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

requires use of key_file.

datacenter^Optional

public java.lang.String getDatacenter();

• Type: java.lang.String

(Optional) The datacenter to use.

Defaults to that of the agent.

gzip^Optional

public java.lang.Boolean getGzip();

• Type: java.lang.Boolean

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

httpAuth^Optional

public java.lang.String getHttpAuth();

• 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

public java.lang.String getKeyFile();

• Type: java.lang.String

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

lock^Optional

public java.lang.Boolean getLock();

• 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

public java.lang.String getScheme();

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

DataTerraformRemoteStateCosConfig

Initializer

import com.hashicorp.cdktf.DataTerraformRemoteStateCosConfig;

DataTerraformRemoteStateCosConfig.builder()
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .bucket(java.lang.String)
//  .accelerate(java.lang.Boolean)
//  .acl(java.lang.String)
//  .assumeRole(CosBackendAssumeRole)
//  .domain(java.lang.String)
//  .encrypt(java.lang.Boolean)
//  .endpoint(java.lang.String)
//  .key(java.lang.String)
//  .prefix(java.lang.String)
//  .region(java.lang.String)
//  .secretId(java.lang.String)
//  .secretKey(java.lang.String)
//  .securityToken(java.lang.String)
    .build();

Properties

defaults^Optional

public java.util.Map< java.lang.String, java.lang.Object > getDefaults();

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

workspace^Optional

public java.lang.String getWorkspace();

• Type: java.lang.String

bucket^Required

public java.lang.String getBucket();

• Type: java.lang.String

(Required) The name of the COS bucket.

You shall manually create it first.

accelerate^Optional

public java.lang.Boolean getAccelerate();

• Type: java.lang.Boolean

(Optional) Whether to enable global Acceleration.

Defaults to false.

acl^Optional

public java.lang.String getAcl();

• Type: java.lang.String

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

Defaults to private.

assumeRole^Optional

public CosBackendAssumeRole getAssumeRole();

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

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

domain^Optional

public java.lang.String getDomain();

• Type: java.lang.String

(Optional) The root domain of the API request.

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

encrypt^Optional

public java.lang.Boolean getEncrypt();

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

endpoint^Optional

public java.lang.String getEndpoint();

• Type: java.lang.String

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

key^Optional

public java.lang.String getKey();

• Type: java.lang.String

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

Defaults to terraform.tfstate.

prefix^Optional

public java.lang.String getPrefix();

• Type: java.lang.String

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

Default to "env:".

region^Optional

public java.lang.String getRegion();

• Type: java.lang.String

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

secretId^Optional

public java.lang.String getSecretId();

• Type: java.lang.String

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

secretKey^Optional

public java.lang.String getSecretKey();

• Type: java.lang.String

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

securityToken^Optional

public java.lang.String getSecurityToken();

• Type: java.lang.String

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

DataTerraformRemoteStateGcsConfig

Initializer

import com.hashicorp.cdktf.DataTerraformRemoteStateGcsConfig;

DataTerraformRemoteStateGcsConfig.builder()
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .bucket(java.lang.String)
//  .accessToken(java.lang.String)
//  .credentials(java.lang.String)
//  .encryptionKey(java.lang.String)
//  .impersonateServiceAccount(java.lang.String)
//  .impersonateServiceAccountDelegates(java.util.List< java.lang.String >)
//  .kmsEncryptionKey(java.lang.String)
//  .prefix(java.lang.String)
//  .storeageCustomEndpoint(java.lang.String)
    .build();

Properties

defaults^Optional

public java.util.Map< java.lang.String, java.lang.Object > getDefaults();

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

workspace^Optional

public java.lang.String getWorkspace();

• Type: java.lang.String

bucket^Required

public java.lang.String getBucket();

• Type: java.lang.String

(Required) The name of the GCS bucket.

This name must be globally unique.

accessToken^Optional

public java.lang.String getAccessToken();

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

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

• Type: java.lang.String

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

impersonateServiceAccount^Optional

public java.lang.String getImpersonateServiceAccount();

• Type: java.lang.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 java.util.List< java.lang.String > getImpersonateServiceAccountDelegates();

• Type: java.util.List< java.lang.String >

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

kmsEncryptionKey^Optional

public java.lang.String getKmsEncryptionKey();

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

• Type: java.lang.String

(Optional) GCS prefix inside the bucket.

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

storeageCustomEndpoint^Optional

public java.lang.String getStoreageCustomEndpoint();

• Type: java.lang.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 com.hashicorp.cdktf.DataTerraformRemoteStateHttpConfig;

DataTerraformRemoteStateHttpConfig.builder()
//  .defaults(java.util.Map< java.lang.String, java.lang.Object >)
//  .workspace(java.lang.String)
    .address(java.lang.String)
//  .clientCaCertificatePem(java.lang.String)
//  .clientCertificatePem(java.lang.String)
//  .clientPrivateKeyPem(java.lang.String)
//  .lockAddress(java.lang.String)
//  .lockMethod(java.lang.String)
//  .password(java.lang.String)
//  .retryMax(java.lang.Number)
//  .retryWaitMax(java.lang.Number)
//  .retryWaitMin(java.lang.Number)
//  .skipCertVerification(java.lang.Boolean)
//  .unlockAddress(java.lang.String)
//  .unlockMethod(java.lang.String)
//  .updateMethod(java.lang.String)
//  .username(java.lang.String)
    .build();

Properties

defaults^Optional

public java.util.Map< java.lang.String, java.lang.Object > getDefaults();

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

workspace^Optional

public java.lang.String getWorkspace();

• Type: java.lang.String

address^Required

public java.lang.String getAddress();

• Type: java.lang.String

(Required) The address of the REST endpoint.

clientCaCertificatePem^Optional

public java.lang.String getClientCaCertificatePem();

• Type: java.lang.String

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

clientCertificatePem^Optional

public java.lang.String getClientCertificatePem();

• Type: java.lang.String

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

clientPrivateKeyPem^Optional

public java.lang.String getClientPrivateKeyPem();

• Type: java.lang.String

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

lockAddress^Optional

public java.lang.String getLockAddress();

• Type: java.lang.String

(Optional) The address of the lock REST endpoint.

Defaults to disabled.

lockMethod^Optional

public java.lang.String getLockMethod();

• Type: java.lang.String

(Optional) The HTTP method to use when locking.

Defaults to LOCK.

password^Optional

public java.lang.String getPassword();