Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Initializers 

import io.cdktn.cdktn.DataTerraformRemoteStateCos;

DataTerraformRemoteStateCos.Builder.create(Construct scope, java.lang.String id)
//  .defaults(java.util.Map<java.lang.String, java.lang.Object>)
//  .workspace(java.lang.String)
    .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();
NameTypeDescription
scopesoftware.constructs.ConstructNo description.
idjava.lang.StringNo description.
defaultsjava.util.Map< java.lang.String, java.lang.Object >No description.
workspacejava.lang.StringNo description.
bucketjava.lang.String(Required) The name of the COS bucket.
acceleratejava.lang.Boolean(Optional) Whether to enable global Acceleration.
acljava.lang.String(Optional) Object ACL to be applied to the state file, allows private and public-read.
assumeRoleCosBackendAssumeRole(Optional) The assume_role block.
domainjava.lang.String(Optional) The root domain of the API request.
encryptjava.lang.Boolean(Optional) Whether to enable server side encryption of the state file.
endpointjava.lang.String(Optional) The Custom Endpoint for the COS backend.
keyjava.lang.String(Optional) The path for saving the state file in bucket.
prefixjava.lang.String(Optional) The directory for saving the state file in bucket.
regionjava.lang.String(Optional) The region of the COS bucket.
secretIdjava.lang.String(Optional) Secret id of Tencent Cloud.
secretKeyjava.lang.String(Optional) Secret key of Tencent Cloud.
securityTokenjava.lang.String(Optional) TencentCloud Security Token of temporary access credentials.

​
scopeRequired

  • Type: software.constructs.Construct

​
idRequired

  • Type: java.lang.String

​
defaultsOptional

  • Type: java.util.Map< java.lang.String, java.lang.Object >

​
workspaceOptional

  • Type: java.lang.String

​
bucketRequired

  • Type: java.lang.String
(Required) The name of the COS bucket. You shall manually create it first.

​
accelerateOptional

  • Type: java.lang.Boolean
(Optional) Whether to enable global Acceleration. Defaults to false.

​
aclOptional

  • Type: java.lang.String
(Optional) Object ACL to be applied to the state file, allows private and public-read. Defaults to private.

​
assumeRoleOptional

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

​
domainOptional

  • Type: java.lang.String
(Optional) The root domain of the API request. Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.

​
encryptOptional

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

​
endpointOptional

  • Type: java.lang.String
(Optional) The Custom Endpoint for the COS backend. It supports the environment variable TENCENTCLOUD_ENDPOINT.

​
keyOptional

  • Type: java.lang.String
(Optional) The path for saving the state file in bucket. Defaults to terraform.tfstate.

​
prefixOptional

  • Type: java.lang.String
(Optional) The directory for saving the state file in bucket. Default to “env:”.

​
regionOptional

  • Type: java.lang.String
(Optional) The region of the COS bucket. It supports environment variables TENCENTCLOUD_REGION.

​
secretIdOptional

  • Type: java.lang.String
(Optional) Secret id of Tencent Cloud. It supports environment variables TENCENTCLOUD_SECRET_ID.

​
secretKeyOptional

  • Type: java.lang.String
(Optional) Secret key of Tencent Cloud. It supports environment variables TENCENTCLOUD_SECRET_KEY.

​
securityTokenOptional

  • Type: java.lang.String
(Optional) TencentCloud Security Token of temporary access credentials. It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

​
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.
toHclTerraformAdds this resource to the terraform JSON output.
toMetadataNo description.
toTerraformAdds this resource to the terraform JSON output.
getNo description.
getBooleanNo description.
getListNo description.
getNumberNo description.
getStringNo description.

​
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()
Adds this resource to the terraform JSON output.

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

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

​
get 

public IResolvable get(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getBoolean 

public IResolvable getBoolean(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getList 

public java.util.List<java.lang.String> getList(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getNumber 

public java.lang.Number getNumber(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
getString 

public java.lang.String getString(java.lang.String output)

​
outputRequired

  • Type: java.lang.String

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.

​
isConstruct 

import io.cdktn.cdktn.DataTerraformRemoteStateCos;

DataTerraformRemoteStateCos.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.DataTerraformRemoteStateCos;

DataTerraformRemoteStateCos.isTerraformElement(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

​
Constants

NameTypeDescription
tfResourceTypejava.lang.StringNo description.

​
tfResourceTypeRequired 

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