CSharp: CosBackendConfig

CDKTN Core API Reference for CosBackendConfig in CSharp.

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

using Io.Cdktn;

new CosBackendConfig {
    string Bucket,
    bool Accelerate = null,
    string Acl = null,
    CosBackendAssumeRole AssumeRole = null,
    string Domain = null,
    bool Encrypt = null,
    string Endpoint = null,
    string Key = null,
    string Prefix = null,
    string Region = null,
    string SecretId = null,
    string SecretKey = null,
    string SecurityToken = null
};

Properties

Name	Type	Description
Bucket	string	(Required) The name of the COS bucket.
Accelerate	bool	(Optional) Whether to enable global Acceleration.
Acl	string	(Optional) Object ACL to be applied to the state file, allows private and public-read.
AssumeRole	CosBackendAssumeRole	(Optional) The assume_role block.
Domain	string	(Optional) The root domain of the API request.
Encrypt	bool	(Optional) Whether to enable server side encryption of the state file.
Endpoint	string	(Optional) The Custom Endpoint for the COS backend.
Key	string	(Optional) The path for saving the state file in bucket.
Prefix	string	(Optional) The directory for saving the state file in bucket.
Region	string	(Optional) The region of the COS bucket.
SecretId	string	(Optional) Secret id of Tencent Cloud.
SecretKey	string	(Optional) Secret key of Tencent Cloud.
SecurityToken	string	(Optional) TencentCloud Security Token of temporary access credentials.

---

Bucket^Required

public string Bucket { get; set; }

• Type: string

(Required) The name of the COS bucket.

You shall manually create it first.

---

Accelerate^Optional

public bool Accelerate { get; set; }

• Type: bool

(Optional) Whether to enable global Acceleration.

Defaults to false.

---

Acl^Optional

public string Acl { get; set; }

• Type: string

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

Defaults to private.

---

AssumeRole^Optional

public CosBackendAssumeRole AssumeRole { get; set; }

• Type: CosBackendAssumeRole

(Optional) The assume_role block.

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

---

Domain^Optional

public string Domain { get; set; }

• Type: string

(Optional) The root domain of the API request.

Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.

---

Encrypt^Optional

public bool Encrypt { get; set; }

• Type: bool

(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 string Endpoint { get; set; }

• Type: string

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD_ENDPOINT.

---

Key^Optional

public string Key { get; set; }

• Type: string

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

Defaults to terraform.tfstate.

---

Prefix^Optional

public string Prefix { get; set; }

• Type: string

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

Default to “env:”.

---

Region^Optional

public string Region { get; set; }

• Type: string

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD_REGION.

---

SecretId^Optional

public string SecretId { get; set; }

• Type: string

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_ID.

---

SecretKey^Optional

public string SecretKey { get; set; }

• Type: string

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD_SECRET_KEY.

---

SecurityToken^Optional

public string SecurityToken { get; set; }

• Type: string

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.

---