Package com.hashicorp.cdktf

Class DataTerraformRemoteStateOssConfig.Jsii$Proxy

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

  • 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(DataTerraformRemoteStateOssConfig.Builder builder)
      Constructor that initializes the object based on literal property values passed by the DataTerraformRemoteStateOssConfig.Builder.

  • Method Details

    • getDefaults

      public final Map<String,Object> getDefaults()
      Specified by:
      getDefaults in interface DataTerraformRemoteStateConfig

    • getWorkspace

      public final String getWorkspace()
      Specified by:
      getWorkspace in interface DataTerraformRemoteStateConfig

    • getBucket

      public final String getBucket()
      Description copied from interface: OssBackendConfig
      (experimental) (Required) The name of the OSS bucket.
      Specified by:
      getBucket in interface OssBackendConfig

    • getAccessKey

      public final String getAccessKey()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) Alibaba Cloud access key.

      It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

      Specified by:
      getAccessKey in interface OssBackendConfig

    • getAcl

      public final String getAcl()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) Object ACL to be applied to the state file.
      Specified by:
      getAcl in interface OssBackendConfig

    • getAssumeRole

      public final OssAssumeRole getAssumeRole()
      Specified by:
      getAssumeRole in interface OssBackendConfig

    • getAssumeRolePolicy

      public final String getAssumeRolePolicy()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.
      Specified by:
      getAssumeRolePolicy in interface OssBackendConfig

    • getAssumeRoleRoleArn

      public final String getAssumeRoleRoleArn()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials.
      Specified by:
      getAssumeRoleRoleArn in interface OssBackendConfig

    • getAssumeRoleSessionExpiration

      public final Number getAssumeRoleSessionExpiration()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.
      Specified by:
      getAssumeRoleSessionExpiration in interface OssBackendConfig

    • getAssumeRoleSessionName

      public final String getAssumeRoleSessionName()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME.
      Specified by:
      getAssumeRoleSessionName in interface OssBackendConfig

    • getEcsRoleName

      public final String getEcsRoleName()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.
      Specified by:
      getEcsRoleName in interface OssBackendConfig

    • getEncrypt

      public final Boolean getEncrypt()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) Whether to enable server side encryption of the state file.

      If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file.

      Specified by:
      getEncrypt in interface OssBackendConfig

    • getEndpoint

      public final String getEndpoint()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) A custom endpoint for the OSS API.

      It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

      Specified by:
      getEndpoint in interface OssBackendConfig

    • getKey

      public final String getKey()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) The name of the state file.

      Defaults to terraform.tfstate.

      Specified by:
      getKey in interface OssBackendConfig

    • getPrefix

      public final String getPrefix()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) The path directory of the state file will be stored.

      Default to "env:".

      Specified by:
      getPrefix in interface OssBackendConfig

    • getProfile

      public final String getProfile()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable.
      Specified by:
      getProfile in interface OssBackendConfig

    • getRegion

      public final String getRegion()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) The region of the OSS bucket.

      It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

      Specified by:
      getRegion in interface OssBackendConfig

    • getSecretKey

      public final String getSecretKey()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) Alibaba Cloud secret access key.

      It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

      Specified by:
      getSecretKey in interface OssBackendConfig

    • getSecurityToken

      public final String getSecurityToken()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) STS access token.

      It supports environment variable ALICLOUD_SECURITY_TOKEN.

      Specified by:
      getSecurityToken in interface OssBackendConfig

    • getSharedCredentialsFile

      public final String getSharedCredentialsFile()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used.
      Specified by:
      getSharedCredentialsFile in interface OssBackendConfig

    • getStsEndpoint

      public final String getStsEndpoint()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.
      Specified by:
      getStsEndpoint in interface OssBackendConfig

    • getTablestoreEndpoint

      public final String getTablestoreEndpoint()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) A custom endpoint for the TableStore API.
      Specified by:
      getTablestoreEndpoint in interface OssBackendConfig

    • getTablestoreTable

      public final String getTablestoreTable()
      Description copied from interface: OssBackendConfig
      (experimental) (Optional) A TableStore table for state locking and consistency.

      The table must have a primary key named LockID of type String.

      Specified by:
      getTablestoreTable in interface OssBackendConfig

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