Typescript: PgBackendConfig - CDK Terrain (CDKTN)

Initializer

import { PgBackendConfig } from 'cdktn'

const pgBackendConfig: PgBackendConfig = { ... }

Properties

Name	Type	Description
`connStr`	`string`	Postgres connection string;
`schemaName`	`string`	Name of the automatically-managed Postgres schema, default to terraform_remote_state.
`skipIndexCreation`	`boolean`	If set to true, the Postgres index must already exist.
`skipSchemaCreation`	`boolean`	If set to true, the Postgres schema must already exist.
`skipTableCreation`	`boolean`	If set to true, the Postgres table must already exist.

`connStr`^Required

public readonly connStr: string;

Type: string

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.

`schemaName`^Optional

public readonly schemaName: string;

Type: string

Name of the automatically-managed Postgres schema, default to terraform_remote_state. Can also be set using the PG_SCHEMA_NAME environment variable.

`skipIndexCreation`^Optional

public readonly skipIndexCreation: boolean;

Type: boolean

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.

`skipSchemaCreation`^Optional

public readonly skipSchemaCreation: boolean;

Type: boolean

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.

`skipTableCreation`^Optional

public readonly skipTableCreation: boolean;

Type: boolean

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.

Typescript: OssBackendConfig

Typescript: Postcondition

⌘I

​Initializer

​Properties

​connStrRequired

​schemaNameOptional

​skipIndexCreationOptional

​skipSchemaCreationOptional

​skipTableCreationOptional