Package com.hashicorp.cdktf

Class PgBackend.Builder

java.lang.Object

com.hashicorp.cdktf.PgBackend.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PgBackend>

Enclosing class:

PgBackend

@Stability(Experimental)
public static final class PgBackend.Builder
extends Object
implements software.amazon.jsii.Builder<PgBackend>

(experimental) A fluent builder for PgBackend.

Method Summary

Modifier and Type	Method	Description
PgBackend	build()
PgBackend.Builder	connStr(String connStr)	(experimental) Postgres connection string;
static PgBackend.Builder	create(software.constructs.Construct scope)
PgBackend.Builder	schemaName(String schemaName)	(experimental) Name of the automatically-managed Postgres schema, default to terraform_remote_state.
PgBackend.Builder	skipIndexCreation(Boolean skipIndexCreation)	(experimental) If set to true, the Postgres index must already exist.
PgBackend.Builder	skipSchemaCreation(Boolean skipSchemaCreation)	(experimental) If set to true, the Postgres schema must already exist.
PgBackend.Builder	skipTableCreation(Boolean skipTableCreation)	(experimental) If set to true, the Postgres table must already exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Experimental)
public static PgBackend.Builder create(software.constructs.Construct scope)

Parameters:

scope - This parameter is required.

Returns:

a new instance of PgBackend.Builder.

connStr

@Stability(Experimental)
public PgBackend.Builder connStr(String connStr)

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

Parameters:

connStr - Postgres connection string;. This parameter is required.

Returns:

this

schemaName

@Stability(Experimental)
public PgBackend.Builder schemaName(String schemaName)

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

Can also be set using the PG_SCHEMA_NAME environment variable.

Parameters:

schemaName - Name of the automatically-managed Postgres schema, default to terraform_remote_state. This parameter is required.

Returns:

this

skipIndexCreation

@Stability(Experimental)
public PgBackend.Builder skipIndexCreation(Boolean skipIndexCreation)

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

Parameters:

skipIndexCreation - If set to true, the Postgres index must already exist. This parameter is required.

Returns:

this

skipSchemaCreation

@Stability(Experimental)
public PgBackend.Builder skipSchemaCreation(Boolean skipSchemaCreation)

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

Parameters:

skipSchemaCreation - If set to true, the Postgres schema must already exist. This parameter is required.

Returns:

this

skipTableCreation

@Stability(Experimental)
public PgBackend.Builder skipTableCreation(Boolean skipTableCreation)

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

Parameters:

skipTableCreation - If set to true, the Postgres table must already exist. This parameter is required.

Returns:

this

build

@Stability(Experimental)
public PgBackend build()

Specified by:

build in interface software.amazon.jsii.Builder<PgBackend>

Returns:

a newly built instance of PgBackend.