> ## 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: RemoteBackend

> CDKTN Core API Reference for RemoteBackend in Python.

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

```python theme={null}
import cdktn

cdktn.RemoteBackend(
  scope: Construct,
  organization: str,
  workspaces: IRemoteWorkspace,
  hostname: str = None,
  token: str = None
)
```

| **Name**                                                                                        | **Type**                                                            | **Description**   |
| ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.RemoteBackend.Initializer.parameter.scope">scope</a></code>               | <code>constructs.Construct</code>                                   | *No description.* |
| <code><a href="#cdktn.RemoteBackend.Initializer.parameter.organization">organization</a></code> | <code>str</code>                                                    | *No description.* |
| <code><a href="#cdktn.RemoteBackend.Initializer.parameter.workspaces">workspaces</a></code>     | <code><a href="#cdktn.IRemoteWorkspace">IRemoteWorkspace</a></code> | *No description.* |
| <code><a href="#cdktn.RemoteBackend.Initializer.parameter.hostname">hostname</a></code>         | <code>str</code>                                                    | *No description.* |
| <code><a href="#cdktn.RemoteBackend.Initializer.parameter.token">token</a></code>               | <code>str</code>                                                    | *No description.* |

***

### `scope`<sup>Required</sup> <a name="scope" id="cdktn.RemoteBackend.Initializer.parameter.scope" />

* *Type:* constructs.Construct

***

### `organization`<sup>Required</sup> <a name="organization" id="cdktn.RemoteBackend.Initializer.parameter.organization" />

* *Type:* str

***

### `workspaces`<sup>Required</sup> <a name="workspaces" id="cdktn.RemoteBackend.Initializer.parameter.workspaces" />

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

***

### `hostname`<sup>Optional</sup> <a name="hostname" id="cdktn.RemoteBackend.Initializer.parameter.hostname" />

* *Type:* str

***

### `token`<sup>Optional</sup> <a name="token" id="cdktn.RemoteBackend.Initializer.parameter.token" />

* *Type:* str

***

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

| **Name**                                                                                                  | **Description**                                                                   |
| --------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| <code><a href="#cdktn.RemoteBackend.toString">to\_string</a></code>                                       | Returns a string representation of this construct.                                |
| <code><a href="#cdktn.RemoteBackend.with">with</a></code>                                                 | Applies one or more mixins to this construct.                                     |
| <code><a href="#cdktn.RemoteBackend.addOverride">add\_override</a></code>                                 | *No description.*                                                                 |
| <code><a href="#cdktn.RemoteBackend.overrideLogicalId">override\_logical\_id</a></code>                   | Overrides the auto-generated logical ID with a specific ID.                       |
| <code><a href="#cdktn.RemoteBackend.resetOverrideLogicalId">reset\_override\_logical\_id</a></code>       | Resets a previously passed logical Id to use the auto-generated logical id again. |
| <code><a href="#cdktn.RemoteBackend.toHclTerraform">to\_hcl\_terraform</a></code>                         | *No description.*                                                                 |
| <code><a href="#cdktn.RemoteBackend.toMetadata">to\_metadata</a></code>                                   | *No description.*                                                                 |
| <code><a href="#cdktn.RemoteBackend.toTerraform">to\_terraform</a></code>                                 | Adds this resource to the terraform JSON output.                                  |
| <code><a href="#cdktn.RemoteBackend.getRemoteStateDataSource">get\_remote\_state\_data\_source</a></code> | Creates a TerraformRemoteState resource that accesses this backend.               |

***

### `to_string` <a name="to_string" id="cdktn.RemoteBackend.toString" />

```python theme={null}
def to_string() -> str
```

Returns a string representation of this construct.

### `with` <a name="with" id="cdktn.RemoteBackend.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`<sup>Required</sup> <a name="mixins" id="cdktn.RemoteBackend.with.parameter.mixins" />

* *Type:* \*constructs.IMixin

The mixins to apply.

***

### `add_override` <a name="add_override" id="cdktn.RemoteBackend.addOverride" />

```python theme={null}
def add_override(
  path: str,
  value: typing.Any
) -> None
```

#### `path`<sup>Required</sup> <a name="path" id="cdktn.RemoteBackend.addOverride.parameter.path" />

* *Type:* str

***

#### `value`<sup>Required</sup> <a name="value" id="cdktn.RemoteBackend.addOverride.parameter.value" />

* *Type:* typing.Any

***

### `override_logical_id` <a name="override_logical_id" id="cdktn.RemoteBackend.overrideLogicalId" />

```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`<sup>Required</sup> <a name="new_logical_id" id="cdktn.RemoteBackend.overrideLogicalId.parameter.newLogicalId" />

* *Type:* str

The new logical ID to use for this stack element.

***

### `reset_override_logical_id` <a name="reset_override_logical_id" id="cdktn.RemoteBackend.resetOverrideLogicalId" />

```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` <a name="to_hcl_terraform" id="cdktn.RemoteBackend.toHclTerraform" />

```python theme={null}
def to_hcl_terraform() -> typing.Any
```

### `to_metadata` <a name="to_metadata" id="cdktn.RemoteBackend.toMetadata" />

```python theme={null}
def to_metadata() -> typing.Any
```

### `to_terraform` <a name="to_terraform" id="cdktn.RemoteBackend.toTerraform" />

```python theme={null}
def to_terraform() -> typing.Any
```

Adds this resource to the terraform JSON output.

### `get_remote_state_data_source` <a name="get_remote_state_data_source" id="cdktn.RemoteBackend.getRemoteStateDataSource" />

```python theme={null}
def get_remote_state_data_source(
  scope: Construct,
  name: str,
  _fromstack: str
) -> TerraformRemoteState
```

Creates a TerraformRemoteState resource that accesses this backend.

#### `scope`<sup>Required</sup> <a name="scope" id="cdktn.RemoteBackend.getRemoteStateDataSource.parameter.scope" />

* *Type:* constructs.Construct

***

#### `name`<sup>Required</sup> <a name="name" id="cdktn.RemoteBackend.getRemoteStateDataSource.parameter.name" />

* *Type:* str

***

#### `_fromstack`<sup>Required</sup> <a name="_fromstack" id="cdktn.RemoteBackend.getRemoteStateDataSource.parameter._fromStack" />

* *Type:* str

***

## Static Functions <a name="Static Functions" id="Static Functions" />

| **Name**                                                                                  | **Description**               |
| ----------------------------------------------------------------------------------------- | ----------------------------- |
| <code><a href="#cdktn.RemoteBackend.isConstruct">is\_construct</a></code>                 | Checks if `x` is a construct. |
| <code><a href="#cdktn.RemoteBackend.isTerraformElement">is\_terraform\_element</a></code> | *No description.*             |
| <code><a href="#cdktn.RemoteBackend.isBackend">is\_backend</a></code>                     | *No description.*             |

***

### `is_construct` <a name="is_construct" id="cdktn.RemoteBackend.isConstruct" />

```python theme={null}
import cdktn

cdktn.RemoteBackend.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`<sup>Required</sup> <a name="x" id="cdktn.RemoteBackend.isConstruct.parameter.x" />

* *Type:* typing.Any

Any object.

***

### `is_terraform_element` <a name="is_terraform_element" id="cdktn.RemoteBackend.isTerraformElement" />

```python theme={null}
import cdktn

cdktn.RemoteBackend.is_terraform_element(
  x: typing.Any
)
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.RemoteBackend.isTerraformElement.parameter.x" />

* *Type:* typing.Any

***

### `is_backend` <a name="is_backend" id="cdktn.RemoteBackend.isBackend" />

```python theme={null}
import cdktn

cdktn.RemoteBackend.is_backend(
  x: typing.Any
)
```

#### `x`<sup>Required</sup> <a name="x" id="cdktn.RemoteBackend.isBackend.parameter.x" />

* *Type:* typing.Any

***

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

| **Name**                                                                                       | **Type**                                                        | **Description**   |
| ---------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ----------------- |
| <code><a href="#cdktn.RemoteBackend.property.node">node</a></code>                             | <code>constructs.Node</code>                                    | The tree node.    |
| <code><a href="#cdktn.RemoteBackend.property.cdktfStack">cdktf\_stack</a></code>               | <code><a href="#cdktn.TerraformStack">TerraformStack</a></code> | *No description.* |
| <code><a href="#cdktn.RemoteBackend.property.fqn">fqn</a></code>                               | <code>str</code>                                                | *No description.* |
| <code><a href="#cdktn.RemoteBackend.property.friendlyUniqueId">friendly\_unique\_id</a></code> | <code>str</code>                                                | *No description.* |

***

### `node`<sup>Required</sup> <a name="node" id="cdktn.RemoteBackend.property.node" />

```python theme={null}
node: Node
```

* *Type:* constructs.Node

The tree node.

***

### `cdktf_stack`<sup>Required</sup> <a name="cdktf_stack" id="cdktn.RemoteBackend.property.cdktfStack" />

```python theme={null}
cdktf_stack: TerraformStack
```

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

***

### `fqn`<sup>Required</sup> <a name="fqn" id="cdktn.RemoteBackend.property.fqn" />

```python theme={null}
fqn: str
```

* *Type:* str

***

### `friendly_unique_id`<sup>Required</sup> <a name="friendly_unique_id" id="cdktn.RemoteBackend.property.friendlyUniqueId" />

```python theme={null}
friendly_unique_id: str
```

* *Type:* str

***
