Java: CosBackendConfig

CDKTN Core API Reference for CosBackendConfig in Java.

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

Name	Type	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.

---

bucket^Required

public java.lang.String getBucket();

• Type: java.lang.String

(Required) The name of the COS bucket.

You shall manually create it first.

---

accelerate^Optional

public java.lang.Boolean getAccelerate();

• Type: java.lang.Boolean

(Optional) Whether to enable global Acceleration.

Defaults to false.

---

acl^Optional

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.

---

assumeRole^Optional

public CosBackendAssumeRole getAssumeRole();

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

If provided, terraform will attempt to assume this role using the supplied credentials.

---

domain^Optional

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.

---

encrypt^Optional

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.

---

endpoint^Optional

public java.lang.String getEndpoint();

• Type: java.lang.String

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

---

key^Optional

public java.lang.String getKey();

• Type: java.lang.String

(Optional) The path for saving the state file in bucket.

Defaults to terraform.tfstate.

---

prefix^Optional

public java.lang.String getPrefix();

• Type: java.lang.String

(Optional) The directory for saving the state file in bucket.

Default to “env:”.

---

region^Optional

public java.lang.String getRegion();

• Type: java.lang.String

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

---

secretId^Optional

public java.lang.String getSecretId();

• Type: java.lang.String

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

---

secretKey^Optional

public java.lang.String getSecretKey();

• Type: java.lang.String

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

---

securityToken^Optional

public java.lang.String getSecurityToken();

• Type: java.lang.String

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

---