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.

Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS). This backend supports state locking. Warning! It is highly recommended that you enable Object Versioning on the COS bucket to allow for state recovery in the case of accidental deletions and human error. Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/cos

​
Initializer 

import io.cdktn.cdktn.CosBackendConfig;

CosBackendConfig.builder()
    .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();

​
Properties

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

​
bucketRequired 

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

​
accelerateOptional 

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

​
aclOptional 

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

​
assumeRoleOptional 

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

​
domainOptional 

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

​
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, COS will use ‘AES256’ encryption algorithm to encrypt state file.

​
endpointOptional 

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

​
keyOptional 

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

​
prefixOptional 

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

​
regionOptional 

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

​
secretIdOptional 

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

​
secretKeyOptional 

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

​
securityTokenOptional 

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