Java: OssBackendConfig

Initializer

import io.cdktn.cdktn.OssBackendConfig;

OssBackendConfig.builder()
    .bucket(java.lang.String)
//  .accessKey(java.lang.String)
//  .acl(java.lang.String)
//  .assumeRole(OssAssumeRole)
//  .assumeRolePolicy(java.lang.String)
//  .assumeRoleRoleArn(java.lang.String)
//  .assumeRoleSessionExpiration(java.lang.Number)
//  .assumeRoleSessionName(java.lang.String)
//  .ecsRoleName(java.lang.String)
//  .encrypt(java.lang.Boolean)
//  .endpoint(java.lang.String)
//  .key(java.lang.String)
//  .prefix(java.lang.String)
//  .profile(java.lang.String)
//  .region(java.lang.String)
//  .secretKey(java.lang.String)
//  .securityToken(java.lang.String)
//  .sharedCredentialsFile(java.lang.String)
//  .stsEndpoint(java.lang.String)
//  .tablestoreEndpoint(java.lang.String)
//  .tablestoreTable(java.lang.String)
    .build();

Properties

Name	Type	Description
`bucket`	`java.lang.String`	(Required) The name of the OSS bucket.
`accessKey`	`java.lang.String`	(Optional) Alibaba Cloud access key.
`acl`	`java.lang.String`	(Optional) Object ACL to be applied to the state file.
`assumeRole`	`OssAssumeRole`	No description.
`assumeRolePolicy`	`java.lang.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.
`assumeRoleRoleArn`	`java.lang.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.
`assumeRoleSessionExpiration`	`java.lang.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.
`assumeRoleSessionName`	`java.lang.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.
`ecsRoleName`	`java.lang.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.
`encrypt`	`java.lang.Boolean`	(Optional) Whether to enable server side encryption of the state file.
`endpoint`	`java.lang.String`	(Optional) A custom endpoint for the OSS API.
`key`	`java.lang.String`	(Optional) The name of the state file.
`prefix`	`java.lang.String`	(Optional) The path directory of the state file will be stored.
`profile`	`java.lang.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.
`region`	`java.lang.String`	(Optional) The region of the OSS bucket.
`secretKey`	`java.lang.String`	(Optional) Alibaba Cloud secret access key.
`securityToken`	`java.lang.String`	(Optional) STS access token.
`sharedCredentialsFile`	`java.lang.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.
`stsEndpoint`	`java.lang.String`	(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.
`tablestoreEndpoint`	`java.lang.String`	(Optional) A custom endpoint for the TableStore API.
`tablestoreTable`	`java.lang.String`	(Optional) A TableStore table for state locking and consistency.

`bucket`^Required

public java.lang.String getBucket();

Type: java.lang.String

(Required) The name of the OSS bucket.

`accessKey`^Optional

public java.lang.String getAccessKey();

Type: java.lang.String

(Optional) Alibaba Cloud access key. It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

`acl`^Optional

public java.lang.String getAcl();

Type: java.lang.String

(Optional) Object ACL to be applied to the state file.

`assumeRole`^Optional

Deprecated: Use flattened assume role options

public OssAssumeRole getAssumeRole();

Type: OssAssumeRole

`assumeRolePolicy`^Optional

public java.lang.String getAssumeRolePolicy();

Type: java.lang.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.

`assumeRoleRoleArn`^Optional

public java.lang.String getAssumeRoleRoleArn();

Type: java.lang.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.

`assumeRoleSessionExpiration`^Optional

public java.lang.Number getAssumeRoleSessionExpiration();

Type: java.lang.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.

`assumeRoleSessionName`^Optional

public java.lang.String getAssumeRoleSessionName();

Type: java.lang.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.

`ecsRoleName`^Optional

public java.lang.String getEcsRoleName();

Type: java.lang.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.

`encrypt`^Optional

public java.lang.Boolean getEncrypt();

Type: java.lang.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.

`endpoint`^Optional

public java.lang.String getEndpoint();

Type: java.lang.String

(Optional) A custom endpoint for the OSS API. It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

`key`^Optional

public java.lang.String getKey();

Type: java.lang.String

(Optional) The name of the state file. Defaults to terraform.tfstate.

`prefix`^Optional

public java.lang.String getPrefix();

Type: java.lang.String

(Optional) The path directory of the state file will be stored. Default to “env:”.

`profile`^Optional

public java.lang.String getProfile();

Type: java.lang.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.

`region`^Optional

public java.lang.String getRegion();

Type: java.lang.String

(Optional) The region of the OSS bucket. It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

`secretKey`^Optional

public java.lang.String getSecretKey();

Type: java.lang.String

(Optional) Alibaba Cloud secret access key. It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

`securityToken`^Optional

public java.lang.String getSecurityToken();

Type: java.lang.String

(Optional) STS access token. It supports environment variable ALICLOUD_SECURITY_TOKEN.

`sharedCredentialsFile`^Optional

public java.lang.String getSharedCredentialsFile();

Type: java.lang.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.

`stsEndpoint`^Optional

public java.lang.String getStsEndpoint();

Type: java.lang.String

(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.

`tablestoreEndpoint`^Optional

public java.lang.String getTablestoreEndpoint();

Type: java.lang.String

(Optional) A custom endpoint for the TableStore API.

`tablestoreTable`^Optional

public java.lang.String getTablestoreTable();

Type: java.lang.String

(Optional) A TableStore table for state locking and consistency. The table must have a primary key named LockID of type String.

Overview

TypeScript

Python

Java

C#

Go

Initializer

Properties

`bucket`^Required

`accessKey`^Optional

`acl`^Optional

`assumeRole`^Optional

`assumeRolePolicy`^Optional

`assumeRoleRoleArn`^Optional

`assumeRoleSessionExpiration`^Optional

`assumeRoleSessionName`^Optional

`ecsRoleName`^Optional

`encrypt`^Optional

`endpoint`^Optional

`key`^Optional

`prefix`^Optional

`profile`^Optional

`region`^Optional

`secretKey`^Optional

`securityToken`^Optional

`sharedCredentialsFile`^Optional

`stsEndpoint`^Optional

`tablestoreEndpoint`^Optional

`tablestoreTable`^Optional

​Initializer

​Properties

​bucketRequired

​accessKeyOptional

​aclOptional

​assumeRoleOptional

​assumeRolePolicyOptional

​assumeRoleRoleArnOptional

​assumeRoleSessionExpirationOptional

​assumeRoleSessionNameOptional

​ecsRoleNameOptional

​encryptOptional

​endpointOptional

​keyOptional

​prefixOptional

​profileOptional

​regionOptional

​secretKeyOptional

​securityTokenOptional

​sharedCredentialsFileOptional

​stsEndpointOptional

​tablestoreEndpointOptional

​tablestoreTableOptional

Initializer

Properties

`bucket`^Required

`accessKey`^Optional

`acl`^Optional

`assumeRole`^Optional

`assumeRolePolicy`^Optional

`assumeRoleRoleArn`^Optional

`assumeRoleSessionExpiration`^Optional

`assumeRoleSessionName`^Optional

`ecsRoleName`^Optional

`encrypt`^Optional

`endpoint`^Optional

`key`^Optional

`prefix`^Optional

`profile`^Optional

`region`^Optional

`secretKey`^Optional

`securityToken`^Optional

`sharedCredentialsFile`^Optional

`stsEndpoint`^Optional

`tablestoreEndpoint`^Optional

`tablestoreTable`^Optional