> ## 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: DataTerraformRemoteStateGcs
> CDKTN Core API Reference for DataTerraformRemoteStateGcs in Python.
## Initializers
```python theme={null}
import cdktn
cdktn.DataTerraformRemoteStateGcs(
scope: Construct,
id: str,
defaults: typing.Mapping[typing.Any] = None,
workspace: str = None,
bucket: str,
access_token: str = None,
credentials: str = None,
encryption_key: str = None,
impersonate_service_account: str = None,
impersonate_service_account_delegates: typing.List[str] = None,
kms_encryption_key: str = None,
prefix: str = None,
storeage_custom_endpoint: 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 GCS bucket. |
| access\_token | str | (Optional) A temporary \[OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access\_token will be used over the credentials field. |
| credentials | str | (Optional) Local path to Google Cloud Platform account credentials in JSON format. |
| encryption\_key | str | (Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state. |
| impersonate\_service\_account | str | (Optional) The service account to impersonate for accessing the State Bucket. |
| impersonate\_service\_account\_delegates | typing.List\[str] | (Optional) The delegation chain for an impersonating a service account. |
| kms\_encryption\_key | str | (Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket. |
| prefix | str | (Optional) GCS prefix inside the bucket. |
| storeage\_custom\_endpoint | str | (Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b). |
***
### `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 GCS bucket.
This name must be globally unique.
***
### `access_token`Optional
* *Type:* str
(Optional) A temporary \[OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access\_token will be used over the credentials field.
***
### `credentials`Optional
* *Type:* str
(Optional) Local path to Google Cloud Platform account credentials in JSON format.
If unset, Google Application Default Credentials are used.
The provided credentials must have Storage Object Admin role on the bucket.
Warning: if using the Google Cloud Platform provider as well,
it will also pick up the GOOGLE\_CREDENTIALS environment variable.
***
### `encryption_key`Optional
* *Type:* str
(Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.
***
### `impersonate_service_account`Optional
* *Type:* str
(Optional) The service account to impersonate for accessing the State Bucket.
You must have roles/iam.serviceAccountTokenCreator role on that account for the impersonation to succeed.
If you are using a delegation chain, you can specify that using the impersonate\_service\_account\_delegates field.
Alternatively, this can be specified using the GOOGLE\_IMPERSONATE\_SERVICE\_ACCOUNT environment variable.
***
### `impersonate_service_account_delegates`Optional
* *Type:* typing.List\[str]
(Optional) The delegation chain for an impersonating a service account.
***
### `kms_encryption_key`Optional
* *Type:* str
(Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket.
Format should be projects/\{\{project}}/locations/\{\{location}}/keyRings/\{\{keyRing}}/cryptoKeys/\{\{name}}.
For more information, including IAM requirements, see [Customer-managed Encryption Keys](https://cloud.google.com/storage/docs/encryption/customer-managed-keys).
***
### `prefix`Optional
* *Type:* str
(Optional) GCS prefix inside the bucket.
Named states for workspaces are stored in an object called \< prefix >/\< name >.tfstate.
***
### `storeage_custom_endpoint`Optional
* *Type:* str
(Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b).
[See here for more details](https://developer.hashicorp.com/terraform/language/settings/backends/gcs#storage_custom_endpoint)
***
## 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.DataTerraformRemoteStateGcs.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.DataTerraformRemoteStateGcs.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
***