> ## 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.
# Python: DataTerraformRemoteStateCosConfig
> CDKTN Core API Reference for DataTerraformRemoteStateCosConfig in Python.
## Initializer
```python theme={null}
import cdktn
cdktn.DataTerraformRemoteStateCosConfig(
defaults: typing.Mapping[typing.Any] = None,
workspace: str = None,
bucket: str,
accelerate: bool = None,
acl: str = None,
assume_role: CosBackendAssumeRole = None,
domain: str = None,
encrypt: bool = None,
endpoint: str = None,
key: str = None,
prefix: str = None,
region: str = None,
secret_id: str = None,
secret_key: str = None,
security_token: str = None
)
```
## Properties
| **Name** | **Type** | **Description** |
| ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| defaults | typing.Mapping\[typing.Any] | *No description.* |
| workspace | str | *No description.* |
| bucket | str | (Required) The name of the COS bucket. |
| accelerate | bool | (Optional) Whether to enable global Acceleration. |
| acl | str | (Optional) Object ACL to be applied to the state file, allows private and public-read. |
| assume\_role | CosBackendAssumeRole | (Optional) The assume\_role block. |
| domain | str | (Optional) The root domain of the API request. |
| encrypt | bool | (Optional) Whether to enable server side encryption of the state file. |
| endpoint | str | (Optional) The Custom Endpoint for the COS backend. |
| key | str | (Optional) The path for saving the state file in bucket. |
| prefix | str | (Optional) The directory for saving the state file in bucket. |
| region | str | (Optional) The region of the COS bucket. |
| secret\_id | str | (Optional) Secret id of Tencent Cloud. |
| secret\_key | str | (Optional) Secret key of Tencent Cloud. |
| security\_token | str | (Optional) TencentCloud Security Token of temporary access credentials. |
***
### `defaults`Optional
```python theme={null}
defaults: typing.Mapping[typing.Any]
```
* *Type:* typing.Mapping\[typing.Any]
***
### `workspace`Optional
```python theme={null}
workspace: str
```
* *Type:* str
***
### `bucket`Required
```python theme={null}
bucket: str
```
* *Type:* str
(Required) The name of the COS bucket.
You shall manually create it first.
***
### `accelerate`Optional
```python theme={null}
accelerate: bool
```
* *Type:* bool
(Optional) Whether to enable global Acceleration.
Defaults to false.
***
### `acl`Optional
```python theme={null}
acl: str
```
* *Type:* str
(Optional) Object ACL to be applied to the state file, allows private and public-read.
Defaults to private.
***
### `assume_role`Optional
```python theme={null}
assume_role: CosBackendAssumeRole
```
* *Type:* CosBackendAssumeRole
(Optional) The assume\_role block.
If provided, terraform will attempt to assume this role using the supplied credentials.
***
### `domain`Optional
```python theme={null}
domain: str
```
* *Type:* str
(Optional) The root domain of the API request.
Defaults to tencentcloudapi.com.
It supports the environment variable TENCENTCLOUD\_DOMAIN.
***
### `encrypt`Optional
```python theme={null}
encrypt: bool
```
* *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
```python theme={null}
endpoint: str
```
* *Type:* str
(Optional) The Custom Endpoint for the COS backend.
It supports the environment variable TENCENTCLOUD\_ENDPOINT.
***
### `key`Optional
```python theme={null}
key: str
```
* *Type:* str
(Optional) The path for saving the state file in bucket.
Defaults to terraform.tfstate.
***
### `prefix`Optional
```python theme={null}
prefix: str
```
* *Type:* str
(Optional) The directory for saving the state file in bucket.
Default to "env:".
***
### `region`Optional
```python theme={null}
region: str
```
* *Type:* str
(Optional) The region of the COS bucket.
It supports environment variables TENCENTCLOUD\_REGION.
***
### `secret_id`Optional
```python theme={null}
secret_id: str
```
* *Type:* str
(Optional) Secret id of Tencent Cloud.
It supports environment variables TENCENTCLOUD\_SECRET\_ID.
***
### `secret_key`Optional
```python theme={null}
secret_key: str
```
* *Type:* str
(Optional) Secret key of Tencent Cloud.
It supports environment variables TENCENTCLOUD\_SECRET\_KEY.
***
### `security_token`Optional
```python theme={null}
security_token: str
```
* *Type:* str
(Optional) TencentCloud Security Token of temporary access credentials.
It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN.
***