Skip to main content

​
Initializers 

import io.cdktn.cdktn.OssBackend;

OssBackend.Builder.create(Construct scope)
    .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();
NameTypeDescription
scopesoftware.constructs.ConstructNo 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.

​
scopeRequired

  • Type: software.constructs.Construct

​
bucketRequired

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

​
accessKeyOptional

  • Type: java.lang.String
(Optional) Alibaba Cloud access key. It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.

​
aclOptional

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

​
assumeRoleOptional

  • Deprecated: Use flattened assume role options
  • Type: OssAssumeRole

​
assumeRolePolicyOptional

  • 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

  • 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

  • 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

  • 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

  • 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

  • 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

  • Type: java.lang.String
(Optional) A custom endpoint for the OSS API. It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.

​
keyOptional

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

​
prefixOptional

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

​
profileOptional

  • 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

  • Type: java.lang.String
(Optional) The region of the OSS bucket. It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.

​
secretKeyOptional

  • Type: java.lang.String
(Optional) Alibaba Cloud secret access key. It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.

​
securityTokenOptional

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

​
sharedCredentialsFileOptional

  • 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

  • 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

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

​
tablestoreTableOptional

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

​
Methods

NameDescription
toStringReturns a string representation of this construct.
addOverrideNo description.
overrideLogicalIdOverrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalIdResets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraformNo description.
toMetadataNo description.
toTerraformAdds this resource to the terraform JSON output.
getRemoteStateDataSourceCreates a TerraformRemoteState resource that accesses this backend.

​
toString 

public java.lang.String toString()
Returns a string representation of this construct.

​
addOverride 

public void addOverride(java.lang.String path, java.lang.Object value)

​
pathRequired

  • Type: java.lang.String

​
valueRequired

  • Type: java.lang.Object

​
overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.

​
newLogicalIdRequired

  • Type: java.lang.String
The new logical ID to use for this stack element.

​
resetOverrideLogicalId 

public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.

​
toHclTerraform 

public java.lang.Object toHclTerraform()

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.

​
getRemoteStateDataSource 

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)
Creates a TerraformRemoteState resource that accesses this backend.

​
scopeRequired

  • Type: software.constructs.Construct

​
nameRequired

  • Type: java.lang.String

​
_fromStackRequired

  • Type: java.lang.String

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.
isBackendNo description.

​
isConstruct 

import io.cdktn.cdktn.OssBackend;

OssBackend.isConstruct(java.lang.Object x)
Checks if x is a construct. Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked. Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

​
xRequired

  • Type: java.lang.Object
Any object.

​
isTerraformElement 

import io.cdktn.cdktn.OssBackend;

OssBackend.isTerraformElement(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
isBackend 

import io.cdktn.cdktn.OssBackend;

OssBackend.isBackend(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
Properties

NameTypeDescription
nodesoftware.constructs.NodeThe tree node.
cdktfStackTerraformStackNo description.
fqnjava.lang.StringNo description.
friendlyUniqueIdjava.lang.StringNo description.

​
nodeRequired 

public Node getNode();
  • Type: software.constructs.Node
The tree node.

​
cdktfStackRequired 

public TerraformStack getCdktfStack();

​
fqnRequired 

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

​
friendlyUniqueIdRequired 

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