Package com.hashicorp.cdktf

Class GcsBackendConfig.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
com.hashicorp.cdktf.GcsBackendConfig.Jsii$Proxy
All Implemented Interfaces:
GcsBackendConfig, software.amazon.jsii.JsiiSerializable
Enclosing interface:
GcsBackendConfig
@Stability(Experimental) @Internal public static final class GcsBackendConfig.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements GcsBackendConfig
An implementation for GcsBackendConfig

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface com.hashicorp.cdktf.GcsBackendConfig

    GcsBackendConfig.Builder, GcsBackendConfig.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(GcsBackendConfig.Builder builder)
    Constructor that initializes the object based on literal property values passed by the GcsBackendConfig.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getAccessToken()
    (experimental) (Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e.
    final String
    getBucket()
    (experimental) (Required) The name of the GCS bucket.
    final String
    getCredentials()
    (experimental) (Optional) Local path to Google Cloud Platform account credentials in JSON format.
    final String
    getEncryptionKey()
    (experimental) (Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.
    final String
    getImpersonateServiceAccount()
    (experimental) (Optional) The service account to impersonate for accessing the State Bucket.
    final List<String>
    getImpersonateServiceAccountDelegates()
    (experimental) (Optional) The delegation chain for an impersonating a service account.
    final String
    getKmsEncryptionKey()
    (experimental) (Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket.
    final String
    getPrefix()
    (experimental) (Optional) GCS prefix inside the bucket.
    final String
    getStoreageCustomEndpoint()
    (experimental) (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).
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(GcsBackendConfig.Builder builder)
      Constructor that initializes the object based on literal property values passed by the GcsBackendConfig.Builder.

  • Method Details

    • getBucket

      public final String getBucket()
      Description copied from interface: GcsBackendConfig
      (experimental) (Required) The name of the GCS bucket.

      This name must be globally unique.

      Specified by:
      getBucket in interface GcsBackendConfig

    • getAccessToken

      public final String getAccessToken()
      Description copied from interface: GcsBackendConfig
      (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.
      Specified by:
      getAccessToken in interface GcsBackendConfig

    • getCredentials

      public final String getCredentials()
      Description copied from interface: GcsBackendConfig
      (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.

      Specified by:
      getCredentials in interface GcsBackendConfig

    • getEncryptionKey

      public final String getEncryptionKey()
      Description copied from interface: GcsBackendConfig
      (experimental) (Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.
      Specified by:
      getEncryptionKey in interface GcsBackendConfig

    • getImpersonateServiceAccount

      public final String getImpersonateServiceAccount()
      Description copied from interface: GcsBackendConfig
      (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.

      Specified by:
      getImpersonateServiceAccount in interface GcsBackendConfig

    • getImpersonateServiceAccountDelegates

      public final List<String> getImpersonateServiceAccountDelegates()
      Description copied from interface: GcsBackendConfig
      (experimental) (Optional) The delegation chain for an impersonating a service account.
      Specified by:
      getImpersonateServiceAccountDelegates in interface GcsBackendConfig

    • getKmsEncryptionKey

      public final String getKmsEncryptionKey()
      Description copied from interface: GcsBackendConfig
      (experimental) (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

      invalid @link 
      {@link https://cloud.google.com/storage/docs/encryption/customer-managed-keys
      Customer-managed Encryption Keys}.
      Specified by:
      getKmsEncryptionKey in interface GcsBackendConfig

    • getPrefix

      public final String getPrefix()
      Description copied from interface: GcsBackendConfig
      (experimental) (Optional) GCS prefix inside the bucket.

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

      Specified by:
      getPrefix in interface GcsBackendConfig

    • getStoreageCustomEndpoint

      public final String getStoreageCustomEndpoint()
      Description copied from interface: GcsBackendConfig
      (experimental) (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).

      invalid @link 
      {@link https://developer.hashicorp.com/terraform/language/settings/backends/gcs#storage_custom_endpoint
      See here for more details}
      Specified by:
      getStoreageCustomEndpoint in interface GcsBackendConfig

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object