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

> CDKTN Core API Reference for DataTerraformRemoteStatePgConfig in Python.

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

```python theme={null}
import cdktn

cdktn.DataTerraformRemoteStatePgConfig(
  defaults: typing.Mapping[typing.Any] = None,
  workspace: str = None,
  conn_str: str,
  schema_name: str = None,
  skip_index_creation: bool = None,
  skip_schema_creation: bool = None,
  skip_table_creation: bool = None
)
```

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

| **Name**                                                                                                              | **Type**                                 | **Description**                                                                         |
| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------------------------------------- |
| <code><a href="#cdktn.DataTerraformRemoteStatePgConfig.property.defaults">defaults</a></code>                         | <code>typing.Mapping\[typing.Any]</code> | *No description.*                                                                       |
| <code><a href="#cdktn.DataTerraformRemoteStatePgConfig.property.workspace">workspace</a></code>                       | <code>str</code>                         | *No description.*                                                                       |
| <code><a href="#cdktn.DataTerraformRemoteStatePgConfig.property.connStr">conn\_str</a></code>                         | <code>str</code>                         | Postgres connection string;                                                             |
| <code><a href="#cdktn.DataTerraformRemoteStatePgConfig.property.schemaName">schema\_name</a></code>                   | <code>str</code>                         | Name of the automatically-managed Postgres schema, default to terraform\_remote\_state. |
| <code><a href="#cdktn.DataTerraformRemoteStatePgConfig.property.skipIndexCreation">skip\_index\_creation</a></code>   | <code>bool</code>                        | If set to true, the Postgres index must already exist.                                  |
| <code><a href="#cdktn.DataTerraformRemoteStatePgConfig.property.skipSchemaCreation">skip\_schema\_creation</a></code> | <code>bool</code>                        | If set to true, the Postgres schema must already exist.                                 |
| <code><a href="#cdktn.DataTerraformRemoteStatePgConfig.property.skipTableCreation">skip\_table\_creation</a></code>   | <code>bool</code>                        | If set to true, the Postgres table must already exist.                                  |

***

### `defaults`<sup>Optional</sup> <a name="defaults" id="cdktn.DataTerraformRemoteStatePgConfig.property.defaults" />

```python theme={null}
defaults: typing.Mapping[typing.Any]
```

* *Type:* typing.Mapping\[typing.Any]

***

### `workspace`<sup>Optional</sup> <a name="workspace" id="cdktn.DataTerraformRemoteStatePgConfig.property.workspace" />

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

* *Type:* str

***

### `conn_str`<sup>Required</sup> <a name="conn_str" id="cdktn.DataTerraformRemoteStatePgConfig.property.connStr" />

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

* *Type:* str

Postgres connection string;

a postgres\:// URL.
The PG\_CONN\_STR and standard libpq environment variables can also be used to indicate how to connect to the PostgreSQL database.

***

### `schema_name`<sup>Optional</sup> <a name="schema_name" id="cdktn.DataTerraformRemoteStatePgConfig.property.schemaName" />

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

* *Type:* str

Name of the automatically-managed Postgres schema, default to terraform\_remote\_state.

Can also be set using the PG\_SCHEMA\_NAME environment variable.

***

### `skip_index_creation`<sup>Optional</sup> <a name="skip_index_creation" id="cdktn.DataTerraformRemoteStatePgConfig.property.skipIndexCreation" />

```python theme={null}
skip_index_creation: bool
```

* *Type:* bool

If set to true, the Postgres index must already exist.

Can also be set using the PG\_SKIP\_INDEX\_CREATION environment variable.
Terraform won't try to create the index, this is useful when it has already been created by a database administrator.

***

### `skip_schema_creation`<sup>Optional</sup> <a name="skip_schema_creation" id="cdktn.DataTerraformRemoteStatePgConfig.property.skipSchemaCreation" />

```python theme={null}
skip_schema_creation: bool
```

* *Type:* bool

If set to true, the Postgres schema must already exist.

Can also be set using the PG\_SKIP\_SCHEMA\_CREATION environment variable.
Terraform won't try to create the schema, this is useful when it has already been created by a database administrator.

***

### `skip_table_creation`<sup>Optional</sup> <a name="skip_table_creation" id="cdktn.DataTerraformRemoteStatePgConfig.property.skipTableCreation" />

```python theme={null}
skip_table_creation: bool
```

* *Type:* bool

If set to true, the Postgres table must already exist.

Can also be set using the PG\_SKIP\_TABLE\_CREATION environment variable.
Terraform won't try to create the table, this is useful when it has already been created by a database administrator.

***