Java: CosBackend - CDK Terrain (CDKTN)

Initializers

import io.cdktn.cdktn.CosBackend;

CosBackend.Builder.create(Construct scope)
    .bucket(java.lang.String)
//  .accelerate(java.lang.Boolean)
//  .acl(java.lang.String)
//  .assumeRole(CosBackendAssumeRole)
//  .domain(java.lang.String)
//  .encrypt(java.lang.Boolean)
//  .endpoint(java.lang.String)
//  .key(java.lang.String)
//  .prefix(java.lang.String)
//  .region(java.lang.String)
//  .secretId(java.lang.String)
//  .secretKey(java.lang.String)
//  .securityToken(java.lang.String)
    .build();

Name	Type	Description
`scope`	`software.constructs.Construct`	No description.
`bucket`	`java.lang.String`	(Required) The name of the COS bucket.
`accelerate`	`java.lang.Boolean`	(Optional) Whether to enable global Acceleration.
`acl`	`java.lang.String`	(Optional) Object ACL to be applied to the state file, allows private and public-read.
`assumeRole`	`CosBackendAssumeRole`	(Optional) The assume_role block.
`domain`	`java.lang.String`	(Optional) The root domain of the API request.
`encrypt`	`java.lang.Boolean`	(Optional) Whether to enable server side encryption of the state file.
`endpoint`	`java.lang.String`	(Optional) The Custom Endpoint for the COS backend.
`key`	`java.lang.String`	(Optional) The path for saving the state file in bucket.
`prefix`	`java.lang.String`	(Optional) The directory for saving the state file in bucket.
`region`	`java.lang.String`	(Optional) The region of the COS bucket.
`secretId`	`java.lang.String`	(Optional) Secret id of Tencent Cloud.
`secretKey`	`java.lang.String`	(Optional) Secret key of Tencent Cloud.
`securityToken`	`java.lang.String`	(Optional) TencentCloud Security Token of temporary access credentials.

`scope`^Required

Type: software.constructs.Construct

`bucket`^Required

Type: java.lang.String

(Required) The name of the COS bucket. You shall manually create it first.

`accelerate`^Optional

Type: java.lang.Boolean

(Optional) Whether to enable global Acceleration. Defaults to false.

`acl`^Optional

Type: java.lang.String

(Optional) Object ACL to be applied to the state file, allows private and public-read. Defaults to private.

`assumeRole`^Optional

Type: CosBackendAssumeRole

(Optional) The assume_role block. If provided, terraform will attempt to assume this role using the supplied credentials.

`domain`^Optional

Type: java.lang.String

(Optional) The root domain of the API request. Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.

`encrypt`^Optional

Type: java.lang.Boolean

(Optional) Whether to enable server side encryption of the state file. If it is true, COS will use ‘AES256’ encryption algorithm to encrypt state file.

`endpoint`^Optional

Type: java.lang.String

(Optional) The Custom Endpoint for the COS backend. It supports the environment variable TENCENTCLOUD_ENDPOINT.

`key`^Optional

Type: java.lang.String

(Optional) The path for saving the state file in bucket. Defaults to terraform.tfstate.

`prefix`^Optional

Type: java.lang.String

(Optional) The directory for saving the state file in bucket. Default to “env:”.

`region`^Optional

Type: java.lang.String

(Optional) The region of the COS bucket. It supports environment variables TENCENTCLOUD_REGION.

`secretId`^Optional

Type: java.lang.String

(Optional) Secret id of Tencent Cloud. It supports environment variables TENCENTCLOUD_SECRET_ID.

`secretKey`^Optional

Type: java.lang.String

(Optional) Secret key of Tencent Cloud. It supports environment variables TENCENTCLOUD_SECRET_KEY.

`securityToken`^Optional

Type: java.lang.String

(Optional) TencentCloud Security Token of temporary access credentials. It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`addOverride`	No description.
`overrideLogicalId`	Overrides the auto-generated logical ID with a specific ID.
`resetOverrideLogicalId`	Resets a previously passed logical Id to use the auto-generated logical id again.
`toHclTerraform`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`getRemoteStateDataSource`	Creates a TerraformRemoteState resource that accesses this backend.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`with`

public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: software.constructs.IMixin…

The mixins to apply.

`addOverride`

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

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

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.

`scope`^Required

Type: software.constructs.Construct

`name`^Required

Type: java.lang.String

`_fromStack`^Required

Type: java.lang.String

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isBackend`	No description.

`isConstruct`

import io.cdktn.cdktn.CosBackend;

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

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import io.cdktn.cdktn.CosBackend;

CosBackend.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isBackend`

import io.cdktn.cdktn.CosBackend;

CosBackend.isBackend(java.lang.Object x)

`x`^Required

Type: java.lang.Object

Properties

Name	Type	Description
`node`	`software.constructs.Node`	The tree node.
`cdktfStack`	`TerraformStack`	No description.
`fqn`	`java.lang.String`	No description.
`friendlyUniqueId`	`java.lang.String`	No description.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

​Initializers

​scopeRequired

​bucketRequired

​accelerateOptional

​aclOptional

​assumeRoleOptional

​domainOptional

​encryptOptional

​endpointOptional

​keyOptional

​prefixOptional

​regionOptional

​secretIdOptional

​secretKeyOptional

​securityTokenOptional

​Methods

​toString

​with

​mixinsRequired

​addOverride

​pathRequired

​valueRequired

​overrideLogicalId

​newLogicalIdRequired

​resetOverrideLogicalId

​toHclTerraform

​toMetadata

​toTerraform

​getRemoteStateDataSource

​scopeRequired

​nameRequired

​_fromStackRequired

​Static Functions

​isConstruct

​xRequired

​isTerraformElement

​xRequired

​isBackend

​xRequired

​Properties

​nodeRequired

​cdktfStackRequired

​fqnRequired

​friendlyUniqueIdRequired

Initializers

`scope`^Required

`bucket`^Required

`accelerate`^Optional

`acl`^Optional

`assumeRole`^Optional

`domain`^Optional

`encrypt`^Optional

`endpoint`^Optional

`key`^Optional

`prefix`^Optional

`region`^Optional

`secretId`^Optional

`secretKey`^Optional

`securityToken`^Optional

Methods

`toString`

`with`

`mixins`^Required

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`getRemoteStateDataSource`

`scope`^Required

`name`^Required

`_fromStack`^Required

Static Functions

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isBackend`

`x`^Required

Properties

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required