Skip to main content

​
Initializer 

import io.cdktn.cdktn.DataTerraformRemoteStateOssConfig;

DataTerraformRemoteStateOssConfig.builder()
//  .defaults(java.util.Map<java.lang.String, java.lang.Object>)
//  .workspace(java.lang.String)
    .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

NameTypeDescription
defaultsjava.util.Map< java.lang.String, java.lang.Object >No description.
workspacejava.lang.StringNo description.
bucketjava.lang.String(Required) The name of the OSS bucket.
accessKeyjava.lang.String(Optional) Alibaba Cloud access key.
acljava.lang.String(Optional) Object ACL to be applied to the state file.
assumeRoleOssAssumeRoleNo description.
assumeRolePolicyjava.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.
assumeRoleRoleArnjava.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.
assumeRoleSessionExpirationjava.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.
assumeRoleSessionNamejava.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.
ecsRoleNamejava.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.
encryptjava.lang.Boolean(Optional) Whether to enable server side encryption of the state file.
endpointjava.lang.String(Optional) A custom endpoint for the OSS API.
keyjava.lang.String(Optional) The name of the state file.
prefixjava.lang.String(Optional) The path directory of the state file will be stored.
profilejava.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.
regionjava.lang.String(Optional) The region of the OSS bucket.
secretKeyjava.lang.String(Optional) Alibaba Cloud secret access key.
securityTokenjava.lang.String(Optional) STS access token.
sharedCredentialsFilejava.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.
stsEndpointjava.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.
tablestoreEndpointjava.lang.String(Optional) A custom endpoint for the TableStore API.
tablestoreTablejava.lang.String(Optional) A TableStore table for state locking and consistency.

​
defaultsOptional 

public java.util.Map<java.lang.String, java.lang.Object> getDefaults();
  • Type: java.util.Map< java.lang.String, java.lang.Object >

​
workspaceOptional 

public java.lang.String getWorkspace();
  • Type: java.lang.String

​
bucketRequired 

public java.lang.String getBucket();
  • Type: java.lang.String
(Required) The name of the OSS bucket.

​
accessKeyOptional 

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.

​
aclOptional 

public java.lang.String getAcl();
  • Type: java.lang.String
(Optional) Object ACL to be applied to the state file.

​
assumeRoleOptional

  • Deprecated: Use flattened assume role options
public OssAssumeRole getAssumeRole();

​
assumeRolePolicyOptional 

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.

​
assumeRoleRoleArnOptional 

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.

​
assumeRoleSessionExpirationOptional 

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.

​
assumeRoleSessionNameOptional 

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.

​
ecsRoleNameOptional 

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.

​
encryptOptional 

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.

​
endpointOptional 

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.

​
keyOptional 

public java.lang.String getKey();
  • Type: java.lang.String
(Optional) The name of the state file. Defaults to terraform.tfstate.

​
prefixOptional 

public java.lang.String getPrefix();
  • Type: java.lang.String
(Optional) The path directory of the state file will be stored. Default to “env:”.

​
profileOptional 

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.

​
regionOptional 

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.

​
secretKeyOptional 

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.

​
securityTokenOptional 

public java.lang.String getSecurityToken();
  • Type: java.lang.String
(Optional) STS access token. It supports environment variable ALICLOUD_SECURITY_TOKEN.

​
sharedCredentialsFileOptional 

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.

​
stsEndpointOptional 

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.

​
tablestoreEndpointOptional 

public java.lang.String getTablestoreEndpoint();
  • Type: java.lang.String
(Optional) A custom endpoint for the TableStore API.

​
tablestoreTableOptional 

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.