Package com.hashicorp.cdktf

Interface OssBackendConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
DataTerraformRemoteStateOssConfig
All Known Implementing Classes:
DataTerraformRemoteStateOssConfig.Jsii$Proxy, OssBackendConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)", date="2024-01-15T15:38:01.060Z") @Stability(Experimental) public interface OssBackendConfig extends software.amazon.jsii.JsiiSerializable

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    OssBackendConfig.Builder
    A builder for OssBackendConfig
    static final class 
    OssBackendConfig.Jsii$Proxy
    An implementation for OssBackendConfig

  • Method Summary

    Modifier and Type
    Method
    Description
    static OssBackendConfig.Builder
    builder()
     
    default String
    getAccessKey()
    (experimental) (Optional) Alibaba Cloud access key.
    default String
    getAcl()
    (experimental) (Optional) Object ACL to be applied to the state file.
    default OssAssumeRole
    getAssumeRole()
    Deprecated.
    Use flattened assume role options
    default String
    getAssumeRolePolicy()
    (experimental) (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials.
    default String
    getAssumeRoleRoleArn()
    (experimental) (Optional, Available in 1.1.0+) The ARN of the role to assume.
    default Number
    getAssumeRoleSessionExpiration()
    (experimental) (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires.
    default String
    getAssumeRoleSessionName()
    (experimental) (Optional, Available in 1.1.0+) The session name to use when assuming the role.
    String
    getBucket()
    (experimental) (Required) The name of the OSS bucket.
    default String
    getEcsRoleName()
    (experimental) (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations.
    default Boolean
    getEncrypt()
    (experimental) (Optional) Whether to enable server side encryption of the state file.
    default String
    getEndpoint()
    (experimental) (Optional) A custom endpoint for the OSS API.
    default String
    getKey()
    (experimental) (Optional) The name of the state file.
    default String
    getPrefix()
    (experimental) (Optional) The path directory of the state file will be stored.
    default String
    getProfile()
    (experimental) (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file.
    default String
    getRegion()
    (experimental) (Optional) The region of the OSS bucket.
    default String
    getSecretKey()
    (experimental) (Optional) Alibaba Cloud secret access key.
    default String
    getSecurityToken()
    (experimental) (Optional) STS access token.
    default String
    getSharedCredentialsFile()
    (experimental) (Optional, Available in 0.12.8+) This is the path to the shared credentials file.
    default String
    getStsEndpoint()
    (experimental) (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API.
    default String
    getTablestoreEndpoint()
    (experimental) (Optional) A custom endpoint for the TableStore API.
    default String
    getTablestoreTable()
    (experimental) (Optional) A TableStore table for state locking and consistency.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getBucket

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

    • getAccessKey

      @Stability(Experimental) @Nullable default String getAccessKey()
      (experimental) (Optional) Alibaba Cloud access key.

      It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

    • getAcl

      @Stability(Experimental) @Nullable default String getAcl()
      (experimental) (Optional) Object ACL to be applied to the state file.

    • getAssumeRole

      @Stability(Deprecated) @Deprecated @Nullable default OssAssumeRole getAssumeRole()
      Deprecated.
      Use flattened assume role options

    • getAssumeRolePolicy

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

    • getAssumeRoleRoleArn

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

    • getAssumeRoleSessionExpiration

      @Stability(Experimental) @Nullable default Number getAssumeRoleSessionExpiration()
      (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.

    • getAssumeRoleSessionName

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

    • getEcsRoleName

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

    • getEncrypt

      @Stability(Experimental) @Nullable default Boolean getEncrypt()
      (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.

    • getEndpoint

      @Stability(Experimental) @Nullable default String getEndpoint()
      (experimental) (Optional) A custom endpoint for the OSS API.

      It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

    • getKey

      @Stability(Experimental) @Nullable default String getKey()
      (experimental) (Optional) The name of the state file.

      Defaults to terraform.tfstate.

    • getPrefix

      @Stability(Experimental) @Nullable default String getPrefix()
      (experimental) (Optional) The path directory of the state file will be stored.

      Default to "env:".

    • getProfile

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

    • getRegion

      @Stability(Experimental) @Nullable default String getRegion()
      (experimental) (Optional) The region of the OSS bucket.

      It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

    • getSecretKey

      @Stability(Experimental) @Nullable default String getSecretKey()
      (experimental) (Optional) Alibaba Cloud secret access key.

      It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

    • getSecurityToken

      @Stability(Experimental) @Nullable default String getSecurityToken()
      (experimental) (Optional) STS access token.

      It supports environment variable ALICLOUD_SECURITY_TOKEN.

    • getSharedCredentialsFile

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

    • getStsEndpoint

      @Stability(Experimental) @Nullable default String getStsEndpoint()
      (experimental) (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.

    • getTablestoreEndpoint

      @Stability(Experimental) @Nullable default String getTablestoreEndpoint()
      (experimental) (Optional) A custom endpoint for the TableStore API.

    • getTablestoreTable

      @Stability(Experimental) @Nullable default String getTablestoreTable()
      (experimental) (Optional) A TableStore table for state locking and consistency.

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

    • builder

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