Package com.hashicorp.cdktf

Interface GcsBackendConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
DataTerraformRemoteStateGcsConfig
All Known Implementing Classes:
DataTerraformRemoteStateGcsConfig.Jsii$Proxy, GcsBackendConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.91.0 (build 1b1f239)", date="2023-12-07T11:27:09.968Z") @Stability(Experimental) public interface GcsBackendConfig extends software.amazon.jsii.JsiiSerializable
(experimental) 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

  • Method Details

    • getBucket

      @Stability(Experimental) @NotNull String getBucket()
      (experimental) (Required) The name of the GCS bucket.

      This name must be globally unique.

    • getAccessToken

      @Stability(Experimental) @Nullable default String getAccessToken()
      (experimental) (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.

    • getCredentials

      @Stability(Experimental) @Nullable default String getCredentials()
      (experimental) (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.

    • getEncryptionKey

      @Stability(Experimental) @Nullable default String getEncryptionKey()
      (experimental) (Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.

    • getImpersonateServiceAccount

      @Stability(Experimental) @Nullable default String getImpersonateServiceAccount()
      (experimental) (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.

    • getImpersonateServiceAccountDelegates

      @Stability(Experimental) @Nullable default List<String> getImpersonateServiceAccountDelegates()
      (experimental) (Optional) The delegation chain for an impersonating a service account.

    • getPrefix

      @Stability(Experimental) @Nullable default String getPrefix()
      (experimental) (Optional) GCS prefix inside the bucket.

      Named states for workspaces are stored in an object called /.tfstate.

    • builder

      @Stability(Experimental) static GcsBackendConfig.Builder builder()
      Returns:
      a GcsBackendConfig.Builder of GcsBackendConfig