Skip to main content

​
Initializer 

import { OssBackendConfig } from 'cdktn'

const ossBackendConfig: OssBackendConfig = { ... }

​
Properties

NameTypeDescription
bucketstring(Required) The name of the OSS bucket.
accessKeystring(Optional) Alibaba Cloud access key.
aclstring(Optional) Object ACL to be applied to the state file.
assumeRoleOssAssumeRoleNo description.
assumeRolePolicystring(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.
assumeRoleRoleArnstring(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.
assumeRoleSessionExpirationnumber(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.
assumeRoleSessionNamestring(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.
ecsRoleNamestring(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.
encryptboolean(Optional) Whether to enable server side encryption of the state file.
endpointstring(Optional) A custom endpoint for the OSS API.
keystring(Optional) The name of the state file.
prefixstring(Optional) The path directory of the state file will be stored.
profilestring(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.
regionstring(Optional) The region of the OSS bucket.
secretKeystring(Optional) Alibaba Cloud secret access key.
securityTokenstring(Optional) STS access token.
sharedCredentialsFilestring(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.
stsEndpointstring(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.
tablestoreEndpointstring(Optional) A custom endpoint for the TableStore API.
tablestoreTablestring(Optional) A TableStore table for state locking and consistency.

​
bucketRequired 

public readonly bucket: string;
  • Type: string
(Required) The name of the OSS bucket.

​
accessKeyOptional 

public readonly accessKey: string;
  • Type: string
(Optional) Alibaba Cloud access key. It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

​
aclOptional 

public readonly acl: string;
  • Type: string
(Optional) Object ACL to be applied to the state file.

​
assumeRoleOptional

  • Deprecated: Use flattened assume role options
public readonly assumeRole: OssAssumeRole;

​
assumeRolePolicyOptional 

public readonly assumeRolePolicy: string;
  • Type: string
(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.

​
assumeRoleRoleArnOptional 

public readonly assumeRoleRoleArn: string;
  • Type: string
(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.

​
assumeRoleSessionExpirationOptional 

public readonly assumeRoleSessionExpiration: number;
  • Type: number
(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.

​
assumeRoleSessionNameOptional 

public readonly assumeRoleSessionName: string;
  • Type: string
(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.

​
ecsRoleNameOptional 

public readonly ecsRoleName: string;
  • Type: string
(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.

​
encryptOptional 

public readonly encrypt: boolean;
  • Type: boolean
(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.

​
endpointOptional 

public readonly endpoint: string;
  • Type: string
(Optional) A custom endpoint for the OSS API. It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

​
keyOptional 

public readonly key: string;
  • Type: string
(Optional) The name of the state file. Defaults to terraform.tfstate.

​
prefixOptional 

public readonly prefix: string;
  • Type: string
(Optional) The path directory of the state file will be stored. Default to “env:”.

​
profileOptional 

public readonly profile: string;
  • Type: string
(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.

​
regionOptional 

public readonly region: string;
  • Type: string
(Optional) The region of the OSS bucket. It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

​
secretKeyOptional 

public readonly secretKey: string;
  • Type: string
(Optional) Alibaba Cloud secret access key. It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

​
securityTokenOptional 

public readonly securityToken: string;
  • Type: string
(Optional) STS access token. It supports environment variable ALICLOUD_SECURITY_TOKEN.

​
sharedCredentialsFileOptional 

public readonly sharedCredentialsFile: string;
  • Type: string
(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.

​
stsEndpointOptional 

public readonly stsEndpoint: string;
  • Type: string
(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.

​
tablestoreEndpointOptional 

public readonly tablestoreEndpoint: string;
  • Type: string
(Optional) A custom endpoint for the TableStore API.

​
tablestoreTableOptional 

public readonly tablestoreTable: string;
  • Type: string
(Optional) A TableStore table for state locking and consistency. The table must have a primary key named LockID of type String.