> ## 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: PgBackend > CDKTN Core API Reference for PgBackend in Python. ## Initializers ```python theme={null} import cdktn cdktn.PgBackend( scope: Construct, conn_str: str, schema_name: str = None, skip_index_creation: bool = None, skip_schema_creation: bool = None, skip_table_creation: bool = None ) ``` | **Name** | **Type** | **Description** | | ----------------------------------------------------------------------------------------------------------- | --------------------------------- | --------------------------------------------------------------------------------------- | | scope | constructs.Construct | *No description.* | | conn\_str | str | Postgres connection string; | | schema\_name | str | Name of the automatically-managed Postgres schema, default to terraform\_remote\_state. | | skip\_index\_creation | bool | If set to true, the Postgres index must already exist. | | skip\_schema\_creation | bool | If set to true, the Postgres schema must already exist. | | skip\_table\_creation | bool | If set to true, the Postgres table must already exist. | *** ### `scope`^Required * *Type:* constructs.Construct *** ### `conn_str`^Required * *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`^Optional * *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`^Optional * *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`^Optional * *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`^Optional * *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. *** ## 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 | *No description.* | | to\_metadata | *No description.* | | to\_terraform | Adds this resource to the terraform JSON output. | | get\_remote\_state\_data\_source | Creates a TerraformRemoteState resource that accesses this backend. | *** ### `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 ``` ### `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_remote_state_data_source` ```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`^Required * *Type:* constructs.Construct *** #### `name`^Required * *Type:* str *** #### `_fromstack`^Required * *Type:* str *** ## Static Functions | **Name** | **Description** | | ------------------------------------------------------------------------------------- | ----------------------------- | | is\_construct | Checks if `x` is a construct. | | is\_terraform\_element | *No description.* | | is\_backend | *No description.* | *** ### `is_construct` ```python theme={null} import cdktn cdktn.PgBackend.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.PgBackend.is_terraform_element( x: typing.Any ) ``` #### `x`^Required * *Type:* typing.Any *** ### `is_backend` ```python theme={null} import cdktn cdktn.PgBackend.is_backend( 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 ***