Package com.hashicorp.cdktf

Interface PgBackendConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DataTerraformRemoteStatePgConfig

All Known Implementing Classes:

DataTerraformRemoteStatePgConfig.Jsii$Proxy, PgBackendConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-17T11:28:52.550Z")
@Stability(Experimental)
public interface PgBackendConfig
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PgBackendConfig.Builder	A builder for PgBackendConfig
static final class	PgBackendConfig.Jsii$Proxy	An implementation for PgBackendConfig

Method Summary

Modifier and Type	Method	Description
static PgBackendConfig.Builder	builder()
String	getConnStr()	(experimental) Postgres connection string;
default String	getSchemaName()	(experimental) Name of the automatically-managed Postgres schema, default to terraform_remote_state.
default Boolean	getSkipIndexCreation()	(experimental) If set to true, the Postgres index must already exist.
default Boolean	getSkipSchemaCreation()	(experimental) If set to true, the Postgres schema must already exist.
default Boolean	getSkipTableCreation()	(experimental) If set to true, the Postgres table must already exist.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getConnStr

@Stability(Experimental)
@NotNull
String getConnStr()

(experimental) 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.

getSchemaName

@Stability(Experimental)
@Nullable
default String getSchemaName()

(experimental) Name of the automatically-managed Postgres schema, default to terraform_remote_state.

Can also be set using the PG_SCHEMA_NAME environment variable.

getSkipIndexCreation

@Stability(Experimental)
@Nullable
default Boolean getSkipIndexCreation()

(experimental) 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.

getSkipSchemaCreation

@Stability(Experimental)
@Nullable
default Boolean getSkipSchemaCreation()

(experimental) 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.

getSkipTableCreation

@Stability(Experimental)
@Nullable
default Boolean getSkipTableCreation()

(experimental) 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.

builder

@Stability(Experimental)
static PgBackendConfig.Builder builder()

Returns:

a PgBackendConfig.Builder of PgBackendConfig