Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS). The bucket must exist prior to configuring the backend. This backend supports state locking. Warning! It is highly recommended that you enable Object Versioning on the GCS 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/gcs

​
Initializer 

using Io.Cdktn;

new GcsBackendConfig {
    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

NameTypeDescription
Bucketstring(Required) The name of the GCS bucket.
AccessTokenstring(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.
Credentialsstring(Optional) Local path to Google Cloud Platform account credentials in JSON format.
EncryptionKeystring(Optional) A 32 byte base64 encoded ‘customer supplied encryption key’ used to encrypt all state.
ImpersonateServiceAccountstring(Optional) The service account to impersonate for accessing the State Bucket.
ImpersonateServiceAccountDelegatesstring[](Optional) The delegation chain for an impersonating a service account.
KmsEncryptionKeystring(Optional) A Cloud KMS key (‘customer-managed encryption key’) used when reading and writing state files in the bucket.
Prefixstring(Optional) GCS prefix inside the bucket.
StoreageCustomEndpointstring(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).

​
BucketRequired 

public string Bucket { get; set; }
  • Type: string
(Required) The name of the GCS bucket. This name must be globally unique.

​
AccessTokenOptional 

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.

​
CredentialsOptional 

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.

​
EncryptionKeyOptional 

public string EncryptionKey { get; set; }
  • Type: string
(Optional) A 32 byte base64 encoded ‘customer supplied encryption key’ used to encrypt all state.

​
ImpersonateServiceAccountOptional 

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.

​
ImpersonateServiceAccountDelegatesOptional 

public string[] ImpersonateServiceAccountDelegates { get; set; }
  • Type: string[]
(Optional) The delegation chain for an impersonating a service account.

​
KmsEncryptionKeyOptional 

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 Customer-managed Encryption Keys.

​
PrefixOptional 

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.

​
StoreageCustomEndpointOptional 

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). See here for more details