> ## 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: DataTerraformRemoteStateOss
> CDKTN Core API Reference for DataTerraformRemoteStateOss in Python.
## Initializers
```python theme={null}
import cdktn
cdktn.DataTerraformRemoteStateOss(
scope: Construct,
id: str,
defaults: typing.Mapping[typing.Any] = None,
workspace: str = None,
bucket: str,
access_key: str = None,
acl: str = None,
assume_role: OssAssumeRole = None,
assume_role_policy: str = None,
assume_role_role_arn: str = None,
assume_role_session_expiration: typing.Union[int, float] = None,
assume_role_session_name: str = None,
ecs_role_name: str = None,
encrypt: bool = None,
endpoint: str = None,
key: str = None,
prefix: str = None,
profile: str = None,
region: str = None,
secret_key: str = None,
security_token: str = None,
shared_credentials_file: str = None,
sts_endpoint: str = None,
tablestore_endpoint: str = None,
tablestore_table: 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 OSS bucket. |
| access\_key | str | (Optional) Alibaba Cloud access key. |
| acl | str | (Optional) Object ACL to be applied to the state file. |
| assume\_role | OssAssumeRole | *No description.* |
| assume\_role\_policy | str | (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. |
| assume\_role\_role\_arn | str | (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD\_ASSUME\_ROLE\_ARN. Terraform executes configuration on account with provided credentials. |
| assume\_role\_session\_expiration | typing.Union\[int, float] | (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_EXPIRATION. |
| assume\_role\_session\_name | str | (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_NAME. |
| ecs\_role\_name | str | (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. |
| encrypt | bool | (Optional) Whether to enable server side encryption of the state file. |
| endpoint | str | (Optional) A custom endpoint for the OSS API. |
| key | str | (Optional) The name of the state file. |
| prefix | str | (Optional) The path directory of the state file will be stored. |
| profile | str | (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD\_PROFILE environment variable. |
| region | str | (Optional) The region of the OSS bucket. |
| secret\_key | str | (Optional) Alibaba Cloud secret access key. |
| security\_token | str | (Optional) STS access token. |
| shared\_credentials\_file | str | (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD\_SHARED\_CREDENTIALS\_FILE environment variable. If this is not set and a profile is specified, \~/.aliyun/config.json will be used. |
| sts\_endpoint | str | (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD\_STS\_ENDPOINT. |
| tablestore\_endpoint | str | (Optional) A custom endpoint for the TableStore API. |
| tablestore\_table | str | (Optional) A TableStore table for state locking and consistency. |
***
### `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 OSS bucket.
***
### `access_key`Optional
* *Type:* str
(Optional) Alibaba Cloud access key.
It supports environment variables ALICLOUD\_ACCESS\_KEY and ALICLOUD\_ACCESS\_KEY\_ID.
***
### `acl`Optional
* *Type:* str
(Optional) Object ACL to be applied to the state file.
***
### ~~`assume_role`~~Optional
* *Deprecated:* Use flattened assume role options
* *Type:* OssAssumeRole
***
### `assume_role_policy`Optional
* *Type:* str
(Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.
***
### `assume_role_role_arn`Optional
* *Type:* str
(Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD\_ASSUME\_ROLE\_ARN. Terraform executes configuration on account with provided credentials.
***
### `assume_role_session_expiration`Optional
* *Type:* typing.Union\[int, float]
(Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: \[900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_EXPIRATION.
***
### `assume_role_session_name`Optional
* *Type:* str
(Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD\_ASSUME\_ROLE\_SESSION\_NAME.
***
### `ecs_role_name`Optional
* *Type:* str
(Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.
***
### `encrypt`Optional
* *Type:* bool
(Optional) Whether to enable server side encryption of the state file.
If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file.
***
### `endpoint`Optional
* *Type:* str
(Optional) A custom endpoint for the OSS API.
It supports environment variables ALICLOUD\_OSS\_ENDPOINT and OSS\_ENDPOINT.
***
### `key`Optional
* *Type:* str
(Optional) The name of the state file.
Defaults to terraform.tfstate.
***
### `prefix`Optional
* *Type:* str
(Optional) The path directory of the state file will be stored.
Default to "env:".
***
### `profile`Optional
* *Type:* str
(Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD\_PROFILE environment variable.
***
### `region`Optional
* *Type:* str
(Optional) The region of the OSS bucket.
It supports environment variables ALICLOUD\_REGION and ALICLOUD\_DEFAULT\_REGION.
***
### `secret_key`Optional
* *Type:* str
(Optional) Alibaba Cloud secret access key.
It supports environment variables ALICLOUD\_SECRET\_KEY and ALICLOUD\_ACCESS\_KEY\_SECRET.
***
### `security_token`Optional
* *Type:* str
(Optional) STS access token.
It supports environment variable ALICLOUD\_SECURITY\_TOKEN.
***
### `shared_credentials_file`Optional
* *Type:* str
(Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD\_SHARED\_CREDENTIALS\_FILE environment variable. If this is not set and a profile is specified, \~/.aliyun/config.json will be used.
***
### `sts_endpoint`Optional
* *Type:* str
(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD\_STS\_ENDPOINT.
***
### `tablestore_endpoint`Optional
* *Type:* str
(Optional) A custom endpoint for the TableStore API.
***
### `tablestore_table`Optional
* *Type:* str
(Optional) A TableStore table for state locking and consistency.
The table must have a primary key named LockID of type String.
***
## 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.DataTerraformRemoteStateOss.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.DataTerraformRemoteStateOss.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
***