CSharp: Structs

AppConfig

Initializer

using HashiCorp.Cdktf;

new AppConfig {
    System.Collections.Generic.IDictionary< string, object > Context = null,
    bool HclOutput = null,
    string Outdir = null,
    bool SkipBackendValidation = null,
    bool SkipValidation = null,
    bool StackTraces = null
};

Properties

Context^Optional

public System.Collections.Generic.IDictionary< string, object > Context { get; set; }

• Type: System.Collections.Generic.IDictionary< string, 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 bool HclOutput { get; set; }

• Type: bool

Outdir^Optional

public string Outdir { get; set; }

• 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 bool SkipBackendValidation { get; set; }

• Type: bool
• Default: false

Whether to skip backend validation during synthesis of the app.

SkipValidation^Optional

public bool SkipValidation { get; set; }

• Type: bool
• Default: false

Whether to skip all validations during synthesis of the app.

StackTraces^Optional

public bool StackTraces { get; set; }

• Type: bool

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

using HashiCorp.Cdktf;

new AzurermBackendConfig {
    string ContainerName,
    string Key,
    string StorageAccountName,
    string AccessKey = null,
    string ClientCertificatePassword = null,
    string ClientCertificatePath = null,
    string ClientId = null,
    string ClientSecret = null,
    string Endpoint = null,
    string Environment = null,
    string MetadataHost = null,
    string MsiEndpoint = null,
    string OidcRequestToken = null,
    string OidcRequestUrl = null,
    string OidcToken = null,
    string OidcTokenFilePath = null,
    string ResourceGroupName = null,
    string SasToken = null,
    bool Snapshot = null,
    string SubscriptionId = null,
    string TenantId = null,
    bool UseAzureadAuth = null,
    bool UseMicrosoftGraph = null,
    bool UseMsi = null,
    bool UseOidc = null
};

Properties

ContainerName^Required

public string ContainerName { get; set; }

• Type: string

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

Key^Required

public string Key { get; set; }

• Type: string

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

StorageAccountName^Required

public string StorageAccountName { get; set; }

• Type: string

(Required) The Name of the Storage Account.

AccessKey^Optional

public string AccessKey { get; set; }

• 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 string ClientCertificatePassword { get; set; }

• 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 string ClientCertificatePath { get; set; }

• 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 string ClientId { get; set; }

• 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 string ClientSecret { get; set; }

• 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 string Endpoint { get; set; }

• 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 string Environment { get; set; }

• 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 string MetadataHost { get; set; }

• 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 string MsiEndpoint { get; set; }

• 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 string OidcRequestToken { get; set; }

• 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 string OidcRequestUrl { get; set; }

• 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 string OidcToken { get; set; }

• 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 string OidcTokenFilePath { get; set; }

• 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 string ResourceGroupName { get; set; }

• Type: string

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

SasToken^Optional

public string SasToken { get; set; }

• 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 bool Snapshot { get; set; }

• Type: bool

(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 string SubscriptionId { get; set; }

• 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 string TenantId { get; set; }

• 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 bool UseAzureadAuth { get; set; }

• Type: bool

(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 bool UseMicrosoftGraph { get; set; }

• Type: bool

(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 bool UseMsi { get; set; }

• Type: bool

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

UseOidc^Optional

public bool UseOidc { get; set; }

• Type: bool

(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

using HashiCorp.Cdktf;

new CloudBackendConfig {
    string Organization,
    object Workspaces,
    string Hostname = null,
    string Token = null
};

Properties

Organization^Required

public string Organization { get; set; }

• Type: string

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

Workspaces^Required

public object Workspaces { get; set; }

• Type: object

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 string Hostname { get; set; }

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

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

Token^Optional

public string Token { get; set; }

• 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

using HashiCorp.Cdktf;

new ConsulBackendConfig {
    string AccessToken,
    string Path,
    string Address = null,
    string CaFile = null,
    string CertFile = null,
    string Datacenter = null,
    bool Gzip = null,
    string HttpAuth = null,
    string KeyFile = null,
    bool Lock = null,
    string Scheme = null
};

Properties

AccessToken^Required

public string AccessToken { get; set; }

• Type: string

(Required) Access token.

Path^Required

public string Path { get; set; }

• Type: string

(Required) Path in the Consul KV store.

Address^Optional

public string Address { get; set; }

• 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 string CaFile { get; set; }

• Type: string

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

CertFile^Optional

public string CertFile { get; set; }

• Type: string

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

requires use of key_file.

Datacenter^Optional

public string Datacenter { get; set; }

• Type: string

(Optional) The datacenter to use.

Defaults to that of the agent.

Gzip^Optional

public bool Gzip { get; set; }

• Type: bool

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

HttpAuth^Optional

public string HttpAuth { get; set; }

• 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 string KeyFile { get; set; }

• Type: string

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

Lock^Optional

public bool Lock { get; set; }

• Type: bool

(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 string Scheme { get; set; }

• 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

using HashiCorp.Cdktf;

new CosBackendAssumeRole {
    string RoleArn,
    double SessionDuration,
    string SessionName,
    object Policy = null
};

Properties

RoleArn^Required

public string RoleArn { get; set; }

• Type: string

(Required) The ARN of the role to assume.

It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_ARN.

SessionDuration^Required

public double SessionDuration { get; set; }

• Type: double

(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 string SessionName { get; set; }

• 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 object Policy { get; set; }

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

using HashiCorp.Cdktf;

new CosBackendConfig {
    string Bucket,
    bool Accelerate = null,
    string Acl = null,
    CosBackendAssumeRole AssumeRole = null,
    string Domain = null,
    bool Encrypt = null,
    string Endpoint = null,
    string Key = null,
    string Prefix = null,
    string Region = null,
    string SecretId = null,
    string SecretKey = null,
    string SecurityToken = null
};

Properties

Bucket^Required

public string Bucket { get; set; }

• Type: string

(Required) The name of the COS bucket.

You shall manually create it first.

Accelerate^Optional

public bool Accelerate { get; set; }

• Type: bool

(Optional) Whether to enable global Acceleration.

Defaults to false.

Acl^Optional

public string Acl { get; set; }

• Type: string

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

Defaults to private.

AssumeRole^Optional

public CosBackendAssumeRole AssumeRole { get; set; }

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

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

Domain^Optional

public string Domain { get; set; }

• Type: string

(Optional) The root domain of the API request.

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

Encrypt^Optional

public bool Encrypt { get; set; }

• Type: bool

(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 string Endpoint { get; set; }

• Type: string

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

Key^Optional

public string Key { get; set; }

• Type: string

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

Defaults to terraform.tfstate.

Prefix^Optional

public string Prefix { get; set; }

• Type: string

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

Default to "env:".

Region^Optional

public string Region { get; set; }

• Type: string

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

SecretId^Optional

public string SecretId { get; set; }

• Type: string

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

SecretKey^Optional

public string SecretKey { get; set; }

• Type: string

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

SecurityToken^Optional

public string SecurityToken { get; set; }

• Type: string

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

DataConfig

Initializer

using HashiCorp.Cdktf;

new DataConfig {
    object Connection = null,
    object Count = null,
    ITerraformDependable[] DependsOn = null,
    ITerraformIterator ForEach = null,
    TerraformResourceLifecycle Lifecycle = null,
    TerraformProvider Provider = null,
    object[] Provisioners = null,
    System.Collections.Generic.IDictionary< string, object > Input = null,
    System.Collections.Generic.IDictionary< string, object > TriggersReplace = null
};

Properties

Connection^Optional

public object Connection { get; set; }

• Type: object

Count^Optional

public object Count { get; set; }

• Type: object

DependsOn^Optional

public ITerraformDependable[] DependsOn { get; set; }

• Type: ITerraformDependable[]

ForEach^Optional

public ITerraformIterator ForEach { get; set; }

• Type: ITerraformIterator

Lifecycle^Optional

public TerraformResourceLifecycle Lifecycle { get; set; }

• Type: TerraformResourceLifecycle

Provider^Optional

public TerraformProvider Provider { get; set; }

• Type: TerraformProvider

Provisioners^Optional

public object[] Provisioners { get; set; }

• Type: object[]

Input^Optional

public System.Collections.Generic.IDictionary< string, object > Input { get; set; }

• Type: System.Collections.Generic.IDictionary< string, 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 System.Collections.Generic.IDictionary< string, object > TriggersReplace { get; set; }

• Type: System.Collections.Generic.IDictionary< string, 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

using HashiCorp.Cdktf;

new DataTerraformRemoteStateAzurermConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null,
    string ContainerName,
    string Key,
    string StorageAccountName,
    string AccessKey = null,
    string ClientCertificatePassword = null,
    string ClientCertificatePath = null,
    string ClientId = null,
    string ClientSecret = null,
    string Endpoint = null,
    string Environment = null,
    string MetadataHost = null,
    string MsiEndpoint = null,
    string OidcRequestToken = null,
    string OidcRequestUrl = null,
    string OidcToken = null,
    string OidcTokenFilePath = null,
    string ResourceGroupName = null,
    string SasToken = null,
    bool Snapshot = null,
    string SubscriptionId = null,
    string TenantId = null,
    bool UseAzureadAuth = null,
    bool UseMicrosoftGraph = null,
    bool UseMsi = null,
    bool UseOidc = null
};

Properties

Defaults^Optional

public System.Collections.Generic.IDictionary< string, object > Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

Workspace^Optional

public string Workspace { get; set; }

• Type: string

ContainerName^Required

public string ContainerName { get; set; }

• Type: string

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

Key^Required

public string Key { get; set; }

• Type: string

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

StorageAccountName^Required

public string StorageAccountName { get; set; }

• Type: string

(Required) The Name of the Storage Account.

AccessKey^Optional

public string AccessKey { get; set; }

• 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 string ClientCertificatePassword { get; set; }

• 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 string ClientCertificatePath { get; set; }

• 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 string ClientId { get; set; }

• 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 string ClientSecret { get; set; }

• 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 string Endpoint { get; set; }

• 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 string Environment { get; set; }

• 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 string MetadataHost { get; set; }

• 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 string MsiEndpoint { get; set; }

• 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 string OidcRequestToken { get; set; }

• 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 string OidcRequestUrl { get; set; }

• 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 string OidcToken { get; set; }

• 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 string OidcTokenFilePath { get; set; }

• 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 string ResourceGroupName { get; set; }

• Type: string

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

SasToken^Optional

public string SasToken { get; set; }

• 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 bool Snapshot { get; set; }

• Type: bool

(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 string SubscriptionId { get; set; }

• 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 string TenantId { get; set; }

• 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 bool UseAzureadAuth { get; set; }

• Type: bool

(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 bool UseMicrosoftGraph { get; set; }

• Type: bool

(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 bool UseMsi { get; set; }

• Type: bool

(Optional) Should Managed Service Identity authentication be used?

This can also be sourced from the ARM_USE_MSI environment variable.

UseOidc^Optional

public bool UseOidc { get; set; }

• Type: bool

(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

using HashiCorp.Cdktf;

new DataTerraformRemoteStateConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null
};

Properties

Defaults^Optional

public System.Collections.Generic.IDictionary< string, object > Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

Workspace^Optional

public string Workspace { get; set; }

• Type: string

DataTerraformRemoteStateConsulConfig

Initializer

using HashiCorp.Cdktf;

new DataTerraformRemoteStateConsulConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null,
    string AccessToken,
    string Path,
    string Address = null,
    string CaFile = null,
    string CertFile = null,
    string Datacenter = null,
    bool Gzip = null,
    string HttpAuth = null,
    string KeyFile = null,
    bool Lock = null,
    string Scheme = null
};

Properties

Defaults^Optional

public System.Collections.Generic.IDictionary< string, object > Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

Workspace^Optional

public string Workspace { get; set; }

• Type: string

AccessToken^Required

public string AccessToken { get; set; }

• Type: string

(Required) Access token.

Path^Required

public string Path { get; set; }

• Type: string

(Required) Path in the Consul KV store.

Address^Optional

public string Address { get; set; }

• 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 string CaFile { get; set; }

• Type: string

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

CertFile^Optional

public string CertFile { get; set; }

• Type: string

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

requires use of key_file.

Datacenter^Optional

public string Datacenter { get; set; }

• Type: string

(Optional) The datacenter to use.

Defaults to that of the agent.

Gzip^Optional

public bool Gzip { get; set; }

• Type: bool

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

HttpAuth^Optional

public string HttpAuth { get; set; }

• 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 string KeyFile { get; set; }

• Type: string

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

Lock^Optional

public bool Lock { get; set; }

• Type: bool

(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 string Scheme { get; set; }

• 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

using HashiCorp.Cdktf;

new DataTerraformRemoteStateCosConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null,
    string Bucket,
    bool Accelerate = null,
    string Acl = null,
    CosBackendAssumeRole AssumeRole = null,
    string Domain = null,
    bool Encrypt = null,
    string Endpoint = null,
    string Key = null,
    string Prefix = null,
    string Region = null,
    string SecretId = null,
    string SecretKey = null,
    string SecurityToken = null
};

Properties

Defaults^Optional

public System.Collections.Generic.IDictionary< string, object > Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

Workspace^Optional

public string Workspace { get; set; }

• Type: string

Bucket^Required

public string Bucket { get; set; }

• Type: string

(Required) The name of the COS bucket.

You shall manually create it first.

Accelerate^Optional

public bool Accelerate { get; set; }

• Type: bool

(Optional) Whether to enable global Acceleration.

Defaults to false.

Acl^Optional

public string Acl { get; set; }

• Type: string

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

Defaults to private.

AssumeRole^Optional

public CosBackendAssumeRole AssumeRole { get; set; }

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

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

Domain^Optional

public string Domain { get; set; }

• Type: string

(Optional) The root domain of the API request.

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

Encrypt^Optional

public bool Encrypt { get; set; }

• Type: bool

(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 string Endpoint { get; set; }

• Type: string

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

Key^Optional

public string Key { get; set; }

• Type: string

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

Defaults to terraform.tfstate.

Prefix^Optional

public string Prefix { get; set; }

• Type: string

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

Default to "env:".

Region^Optional

public string Region { get; set; }

• Type: string

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

SecretId^Optional

public string SecretId { get; set; }

• Type: string

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

SecretKey^Optional

public string SecretKey { get; set; }

• Type: string

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

SecurityToken^Optional

public string SecurityToken { get; set; }

• Type: string

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

DataTerraformRemoteStateGcsConfig

Initializer

using HashiCorp.Cdktf;

new DataTerraformRemoteStateGcsConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null,
    string Bucket,
    string AccessToken = null,
    string Credentials = null,
    string EncryptionKey = null,
    string ImpersonateServiceAccount = null,
    string[] ImpersonateServiceAccountDelegates = null,
    string KmsEncryptionKey = null,
    string Prefix = null,
    string StoreageCustomEndpoint = null
};

Properties

Defaults^Optional

public System.Collections.Generic.IDictionary< string, object > Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

Workspace^Optional

public string Workspace { get; set; }

• Type: string

Bucket^Required

public string Bucket { get; set; }

• Type: string

(Required) The name of the GCS bucket.

This name must be globally unique.

AccessToken^Optional

public string AccessToken { get; set; }

• 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 string Credentials { get; set; }

• 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 string EncryptionKey { get; set; }

• Type: string

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

ImpersonateServiceAccount^Optional

public string ImpersonateServiceAccount { get; set; }

• 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 string[] ImpersonateServiceAccountDelegates { get; set; }

• Type: string[]

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

KmsEncryptionKey^Optional

public string KmsEncryptionKey { get; set; }

• 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 string Prefix { get; set; }

• Type: string

(Optional) GCS prefix inside the bucket.

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

StoreageCustomEndpoint^Optional

public string StoreageCustomEndpoint { get; set; }

• 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

using HashiCorp.Cdktf;

new DataTerraformRemoteStateHttpConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null,
    string Address,
    string ClientCaCertificatePem = null,
    string ClientCertificatePem = null,
    string ClientPrivateKeyPem = null,
    string LockAddress = null,
    string LockMethod = null,
    string Password = null,
    double RetryMax = null,
    double RetryWaitMax = null,
    double RetryWaitMin = null,
    bool SkipCertVerification = null,
    string UnlockAddress = null,
    string UnlockMethod = null,
    string UpdateMethod = null,
    string Username = null
};

Properties

Defaults^Optional

public System.Collections.Generic.IDictionary< string, object > Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

Workspace^Optional

public string Workspace { get; set; }

• Type: string

Address^Required

public string Address { get; set; }

• Type: string

(Required) The address of the REST endpoint.

ClientCaCertificatePem^Optional

public string ClientCaCertificatePem { get; set; }

• Type: string

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

ClientCertificatePem^Optional

public string ClientCertificatePem { get; set; }

• Type: string

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

ClientPrivateKeyPem^Optional

public string ClientPrivateKeyPem { get; set; }

• Type: string

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

LockAddress^Optional

public string LockAddress { get; set; }

• Type: string

(Optional) The address of the lock REST endpoint.

Defaults to disabled.

LockMethod^Optional

public string LockMethod { get; set; }

• Type: string

(Optional) The HTTP method to use when locking.

Defaults to LOCK.

Password^Optional

public string Password { get; set; }

• Type: string

(Optional) The password for HTTP basic authentication.

RetryMax^Optional

public double RetryMax { get; set; }

• Type: double

(Optional) The number of HTTP request retries.

Defaults to 2.

RetryWaitMax^Optional

public double RetryWaitMax { get; set; }

• Type: double

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

Defaults to 30.

RetryWaitMin^Optional

public double RetryWaitMin { get; set; }

• Type: double

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

Defaults to 1.

SkipCertVerification^Optional

public bool SkipCertVerification { get; set; }

• Type: bool

(Optional) Whether to skip TLS verification.

Defaults to false.

UnlockAddress^Optional

public string UnlockAddress { get; set; }

• Type: string

(Optional) The address of the unlock REST endpoint.

Defaults to disabled.

UnlockMethod^Optional

public string UnlockMethod { get; set; }

• Type: string

(Optional) The HTTP method to use when unlocking.

Defaults to UNLOCK.

UpdateMethod^Optional

public string UpdateMethod { get; set; }

• Type: string

(Optional) HTTP method to use when updating state.

Defaults to POST.

Username^Optional

public string Username { get; set; }

• Type: string

(Optional) The username for HTTP basic authentication.

DataTerraformRemoteStateLocalConfig

Initializer

using HashiCorp.Cdktf;

new DataTerraformRemoteStateLocalConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null,
    string Path = null,
    string WorkspaceDir = null
};

Properties

Defaults^Optional

public System.Collections.Generic.IDictionary< string, object > Defaults { get; set; }

• Type: System.Collections.Generic.IDictionary< string, object >

Workspace^Optional

public string Workspace { get; set; }

• Type: string

Path^Optional

public string Path { get; set; }

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

Path where the state file is stored.

WorkspaceDir^Optional

public string WorkspaceDir { get; set; }

• Type: string

(Optional) The path to non-default workspaces.

DataTerraformRemoteStateOssConfig

Initializer

using HashiCorp.Cdktf;

new DataTerraformRemoteStateOssConfig {
    System.Collections.Generic.IDictionary< string, object > Defaults = null,
    string Workspace = null,
    string Bucket,
    string AccessKey = null,
    string Acl = null,
    OssAssumeRole AssumeRole = null,
    string AssumeRolePolicy = null,
    string AssumeRoleRoleArn = null,
    double AssumeRoleSessionExpiration = null,
    string AssumeRoleSessionName = null,
    string EcsRoleName = null,
    bool Encrypt = null,
    string Endpoint = null,
    string Key = null,
    string Prefix = null,
    string Profile = null,
    string Region = null,
    string SecretKey = null,
    string SecurityToken = null,
    string SharedCredentialsFile = null,
    string StsEndpoint = null,
    string TablestoreEndpoint = null,
    string TablestoreTable = null
};