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

# Typescript: DataTerraformRemoteStateCosConfig

> CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in Typescript.

## Initializer <a name="Initializer" id="cdktn.DataTerraformRemoteStateCosConfig.Initializer" />

```typescript theme={null}
import { DataTerraformRemoteStateCosConfig } from 'cdktn'

const dataTerraformRemoteStateCosConfig: DataTerraformRemoteStateCosConfig = { ... }
```

## Properties <a name="Properties" id="Properties" />

| **Name**                                                                                                 | **Type**                                                                    | **Description**                                                                        |
| -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.defaults">defaults</a></code>           | <code>\{\[ key: string ]: any}</code>                                       | *No description.*                                                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.workspace">workspace</a></code>         | <code>string</code>                                                         | *No description.*                                                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.bucket">bucket</a></code>               | <code>string</code>                                                         | (Required) The name of the COS bucket.                                                 |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.accelerate">accelerate</a></code>       | <code>boolean</code>                                                        | (Optional) Whether to enable global Acceleration.                                      |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.acl">acl</a></code>                     | <code>string</code>                                                         | (Optional) Object ACL to be applied to the state file, allows private and public-read. |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.assumeRole">assumeRole</a></code>       | <code><a href="#cdktn.CosBackendAssumeRole">CosBackendAssumeRole</a></code> | (Optional) The assume\_role block.                                                     |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.domain">domain</a></code>               | <code>string</code>                                                         | (Optional) The root domain of the API request.                                         |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.encrypt">encrypt</a></code>             | <code>boolean</code>                                                        | (Optional) Whether to enable server side encryption of the state file.                 |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.endpoint">endpoint</a></code>           | <code>string</code>                                                         | (Optional) The Custom Endpoint for the COS backend.                                    |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.key">key</a></code>                     | <code>string</code>                                                         | (Optional) The path for saving the state file in bucket.                               |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.prefix">prefix</a></code>               | <code>string</code>                                                         | (Optional) The directory for saving the state file in bucket.                          |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.region">region</a></code>               | <code>string</code>                                                         | (Optional) The region of the COS bucket.                                               |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.secretId">secretId</a></code>           | <code>string</code>                                                         | (Optional) Secret id of Tencent Cloud.                                                 |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.secretKey">secretKey</a></code>         | <code>string</code>                                                         | (Optional) Secret key of Tencent Cloud.                                                |
| <code><a href="#cdktn.DataTerraformRemoteStateCosConfig.property.securityToken">securityToken</a></code> | <code>string</code>                                                         | (Optional) TencentCloud Security Token of temporary access credentials.                |

***

### `defaults`<sup>Optional</sup> <a name="defaults" id="cdktn.DataTerraformRemoteStateCosConfig.property.defaults" />

```typescript theme={null}
public readonly defaults: {[ key: string ]: any};
```

* *Type:* \{\[ key: string ]: any}

***

### `workspace`<sup>Optional</sup> <a name="workspace" id="cdktn.DataTerraformRemoteStateCosConfig.property.workspace" />

```typescript theme={null}
public readonly workspace: string;
```

* *Type:* string

***

### `bucket`<sup>Required</sup> <a name="bucket" id="cdktn.DataTerraformRemoteStateCosConfig.property.bucket" />

```typescript theme={null}
public readonly bucket: string;
```

* *Type:* string

(Required) The name of the COS bucket.

You shall manually create it first.

***

### `accelerate`<sup>Optional</sup> <a name="accelerate" id="cdktn.DataTerraformRemoteStateCosConfig.property.accelerate" />

```typescript theme={null}
public readonly accelerate: boolean;
```

* *Type:* boolean

(Optional) Whether to enable global Acceleration.

Defaults to false.

***

### `acl`<sup>Optional</sup> <a name="acl" id="cdktn.DataTerraformRemoteStateCosConfig.property.acl" />

```typescript theme={null}
public readonly acl: string;
```

* *Type:* string

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

Defaults to private.

***

### `assumeRole`<sup>Optional</sup> <a name="assumeRole" id="cdktn.DataTerraformRemoteStateCosConfig.property.assumeRole" />

```typescript theme={null}
public readonly assumeRole: CosBackendAssumeRole;
```

* *Type:* <a href="#cdktn.CosBackendAssumeRole">CosBackendAssumeRole</a>

(Optional) The assume\_role block.

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

***

### `domain`<sup>Optional</sup> <a name="domain" id="cdktn.DataTerraformRemoteStateCosConfig.property.domain" />

```typescript theme={null}
public readonly domain: string;
```

* *Type:* string

(Optional) The root domain of the API request.

Defaults to tencentcloudapi.com.
It supports the environment variable TENCENTCLOUD\_DOMAIN.

***

### `encrypt`<sup>Optional</sup> <a name="encrypt" id="cdktn.DataTerraformRemoteStateCosConfig.property.encrypt" />

```typescript theme={null}
public readonly encrypt: boolean;
```

* *Type:* 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`<sup>Optional</sup> <a name="endpoint" id="cdktn.DataTerraformRemoteStateCosConfig.property.endpoint" />

```typescript theme={null}
public readonly endpoint: string;
```

* *Type:* string

(Optional) The Custom Endpoint for the COS backend.

It supports the environment variable TENCENTCLOUD\_ENDPOINT.

***

### `key`<sup>Optional</sup> <a name="key" id="cdktn.DataTerraformRemoteStateCosConfig.property.key" />

```typescript theme={null}
public readonly key: string;
```

* *Type:* string

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

Defaults to terraform.tfstate.

***

### `prefix`<sup>Optional</sup> <a name="prefix" id="cdktn.DataTerraformRemoteStateCosConfig.property.prefix" />

```typescript theme={null}
public readonly prefix: string;
```

* *Type:* string

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

Default to "env:".

***

### `region`<sup>Optional</sup> <a name="region" id="cdktn.DataTerraformRemoteStateCosConfig.property.region" />

```typescript theme={null}
public readonly region: string;
```

* *Type:* string

(Optional) The region of the COS bucket.

It supports environment variables TENCENTCLOUD\_REGION.

***

### `secretId`<sup>Optional</sup> <a name="secretId" id="cdktn.DataTerraformRemoteStateCosConfig.property.secretId" />

```typescript theme={null}
public readonly secretId: string;
```

* *Type:* string

(Optional) Secret id of Tencent Cloud.

It supports environment variables TENCENTCLOUD\_SECRET\_ID.

***

### `secretKey`<sup>Optional</sup> <a name="secretKey" id="cdktn.DataTerraformRemoteStateCosConfig.property.secretKey" />

```typescript theme={null}
public readonly secretKey: string;
```

* *Type:* string

(Optional) Secret key of Tencent Cloud.

It supports environment variables TENCENTCLOUD\_SECRET\_KEY.

***

### `securityToken`<sup>Optional</sup> <a name="securityToken" id="cdktn.DataTerraformRemoteStateCosConfig.property.securityToken" />

```typescript theme={null}
public readonly securityToken: string;
```

* *Type:* string

(Optional) TencentCloud Security Token of temporary access credentials.

It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN.

***