CSharp: PgBackendConfig

CDKTN Core API Reference for PgBackendConfig in CSharp.

Initializer

using Io.Cdktn;

new PgBackendConfig {
    string ConnStr,
    string SchemaName = null,
    bool SkipIndexCreation = null,
    bool SkipSchemaCreation = null,
    bool SkipTableCreation = null
};

Properties

Name	Type	Description
ConnStr	string	Postgres connection string;
SchemaName	string	Name of the automatically-managed Postgres schema, default to terraform_remote_state.
SkipIndexCreation	bool	If set to true, the Postgres index must already exist.
SkipSchemaCreation	bool	If set to true, the Postgres schema must already exist.
SkipTableCreation	bool	If set to true, the Postgres table must already exist.

---

ConnStr^Required

public string ConnStr { get; set; }

• 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 string SchemaName { get; set; }

• 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 bool SkipIndexCreation { get; set; }

• 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.

---

SkipSchemaCreation^Optional

public bool SkipSchemaCreation { get; set; }

• 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.

---

SkipTableCreation^Optional

public bool SkipTableCreation { get; set; }

• 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.

---