Skip to main content

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.

​
Initializer 

import cdktn

cdktn.PgBackendConfig(
  conn_str: str,
  schema_name: str = None,
  skip_index_creation: bool = None,
  skip_schema_creation: bool = None,
  skip_table_creation: bool = None
)

​
Properties

NameTypeDescription
conn_strstrPostgres connection string;
schema_namestrName of the automatically-managed Postgres schema, default to terraform_remote_state.
skip_index_creationboolIf set to true, the Postgres index must already exist.
skip_schema_creationboolIf set to true, the Postgres schema must already exist.
skip_table_creationboolIf set to true, the Postgres table must already exist.

​
conn_strRequired 

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_nameOptional 

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_creationOptional 

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_creationOptional 

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_creationOptional 

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.