> ## 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: DataTerraformRemoteStateCos
> CDKTN Core API Reference for DataTerraformRemoteStateCos in Python.
## Initializers
```python theme={null}
import cdktn
cdktn.DataTerraformRemoteStateCos(
scope: Construct,
id: str,
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
)
```
| **Name** | **Type** | **Description** |
| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| scope | constructs.Construct | *No description.* |
| id | str | *No 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. |
***
### `scope`Required
* *Type:* constructs.Construct
***
### `id`Required
* *Type:* str
***
### `defaults`Optional
* *Type:* typing.Mapping\[typing.Any]
***
### `workspace`Optional
* *Type:* str
***
### `bucket`Required
* *Type:* str
(Required) The name of the COS bucket.
You shall manually create it first.
***
### `accelerate`Optional
* *Type:* bool
(Optional) Whether to enable global Acceleration.
Defaults to false.
***
### `acl`Optional
* *Type:* str
(Optional) Object ACL to be applied to the state file, allows private and public-read.
Defaults to private.
***
### `assume_role`Optional
* *Type:* CosBackendAssumeRole
(Optional) The assume\_role block.
If provided, terraform will attempt to assume this role using the supplied credentials.
***
### `domain`Optional
* *Type:* str
(Optional) The root domain of the API request.
Defaults to tencentcloudapi.com.
It supports the environment variable TENCENTCLOUD\_DOMAIN.
***
### `encrypt`Optional
* *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
* *Type:* str
(Optional) The Custom Endpoint for the COS backend.
It supports the environment variable TENCENTCLOUD\_ENDPOINT.
***
### `key`Optional
* *Type:* str
(Optional) The path for saving the state file in bucket.
Defaults to terraform.tfstate.
***
### `prefix`Optional
* *Type:* str
(Optional) The directory for saving the state file in bucket.
Default to "env:".
***
### `region`Optional
* *Type:* str
(Optional) The region of the COS bucket.
It supports environment variables TENCENTCLOUD\_REGION.
***
### `secret_id`Optional
* *Type:* str
(Optional) Secret id of Tencent Cloud.
It supports environment variables TENCENTCLOUD\_SECRET\_ID.
***
### `secret_key`Optional
* *Type:* str
(Optional) Secret key of Tencent Cloud.
It supports environment variables TENCENTCLOUD\_SECRET\_KEY.
***
### `security_token`Optional
* *Type:* str
(Optional) TencentCloud Security Token of temporary access credentials.
It supports environment variables TENCENTCLOUD\_SECURITY\_TOKEN.
***
## Methods
| **Name** | **Description** |
| ----------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| to\_string | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
| add\_override | *No description.* |
| override\_logical\_id | Overrides the auto-generated logical ID with a specific ID. |
| reset\_override\_logical\_id | Resets a previously passed logical Id to use the auto-generated logical id again. |
| to\_hcl\_terraform | Adds this resource to the terraform JSON output. |
| to\_metadata | *No description.* |
| to\_terraform | Adds this resource to the terraform JSON output. |
| get | *No description.* |
| get\_boolean | *No description.* |
| get\_list | *No description.* |
| get\_number | *No description.* |
| get\_string | *No description.* |
***
### `to_string`
```python theme={null}
def to_string() -> str
```
Returns a string representation of this construct.
### `with`
```python theme={null}
def with(
mixins: *IMixin
) -> IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
#### `mixins`Required
* *Type:* \*constructs.IMixin
The mixins to apply.
***
### `add_override`
```python theme={null}
def add_override(
path: str,
value: typing.Any
) -> None
```
#### `path`Required
* *Type:* str
***
#### `value`Required
* *Type:* typing.Any
***
### `override_logical_id`
```python theme={null}
def override_logical_id(
new_logical_id: str
) -> None
```
Overrides the auto-generated logical ID with a specific ID.
#### `new_logical_id`Required
* *Type:* str
The new logical ID to use for this stack element.
***
### `reset_override_logical_id`
```python theme={null}
def reset_override_logical_id() -> None
```
Resets a previously passed logical Id to use the auto-generated logical id again.
### `to_hcl_terraform`
```python theme={null}
def to_hcl_terraform() -> typing.Any
```
Adds this resource to the terraform JSON output.
### `to_metadata`
```python theme={null}
def to_metadata() -> typing.Any
```
### `to_terraform`
```python theme={null}
def to_terraform() -> typing.Any
```
Adds this resource to the terraform JSON output.
### `get`
```python theme={null}
def get(
output: str
) -> IResolvable
```
#### `output`Required
* *Type:* str
***
### `get_boolean`
```python theme={null}
def get_boolean(
output: str
) -> IResolvable
```
#### `output`Required
* *Type:* str
***
### `get_list`
```python theme={null}
def get_list(
output: str
) -> typing.List[str]
```
#### `output`Required
* *Type:* str
***
### `get_number`
```python theme={null}
def get_number(
output: str
) -> typing.Union[int, float]
```
#### `output`Required
* *Type:* str
***
### `get_string`
```python theme={null}
def get_string(
output: str
) -> str
```
#### `output`Required
* *Type:* str
***
## Static Functions
| **Name** | **Description** |
| ------------------------------------------------------------------------------------------------------- | ----------------------------- |
| is\_construct | Checks if `x` is a construct. |
| is\_terraform\_element | *No description.* |
***
### `is_construct`
```python theme={null}
import cdktn
cdktn.DataTerraformRemoteStateCos.is_construct(
x: typing.Any
)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
#### `x`Required
* *Type:* typing.Any
Any object.
***
### `is_terraform_element`
```python theme={null}
import cdktn
cdktn.DataTerraformRemoteStateCos.is_terraform_element(
x: typing.Any
)
```
#### `x`Required
* *Type:* typing.Any
***
## Properties
| **Name** | **Type** | **Description** |
| ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------- | ----------------- |
| node | constructs.Node | The tree node. |
| cdktf\_stack | TerraformStack | *No description.* |
| fqn | str | *No description.* |
| friendly\_unique\_id | str | *No description.* |
***
### `node`Required
```python theme={null}
node: Node
```
* *Type:* constructs.Node
The tree node.
***
### `cdktf_stack`Required
```python theme={null}
cdktf_stack: TerraformStack
```
* *Type:* TerraformStack
***
### `fqn`Required
```python theme={null}
fqn: str
```
* *Type:* str
***
### `friendly_unique_id`Required
```python theme={null}
friendly_unique_id: str
```
* *Type:* str
***
## Constants
| **Name** | **Type** | **Description** |
| ---------------------------------------------------------------------------------------------------- | ---------------- | ----------------- |
| tfResourceType | str | *No description.* |
***
### `tfResourceType`Required
```python theme={null}
tfResourceType: str
```
* *Type:* str
***