Package com.hashicorp.cdktf

Class PgBackendConfig.Builder

java.lang.Object
com.hashicorp.cdktf.PgBackendConfig.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<PgBackendConfig>
Enclosing interface:
PgBackendConfig
@Stability(Experimental) public static final class PgBackendConfig.Builder extends Object implements software.amazon.jsii.Builder<PgBackendConfig>
A builder for PgBackendConfig

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • connStr

      @Stability(Experimental) public PgBackendConfig.Builder connStr(String connStr)
      Sets the value of PgBackendConfig.getConnStr()
      Parameters:
      connStr - Postgres connection string;. This parameter is required. 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.
      Returns:
      this

    • schemaName

      @Stability(Experimental) public PgBackendConfig.Builder schemaName(String schemaName)
      Sets the value of PgBackendConfig.getSchemaName()
      Parameters:
      schemaName - Name of the automatically-managed Postgres schema, default to terraform_remote_state. Can also be set using the PG_SCHEMA_NAME environment variable.
      Returns:
      this

    • skipIndexCreation

      @Stability(Experimental) public PgBackendConfig.Builder skipIndexCreation(Boolean skipIndexCreation)
      Sets the value of PgBackendConfig.getSkipIndexCreation()
      Parameters:
      skipIndexCreation - 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.
      Returns:
      this

    • skipSchemaCreation

      @Stability(Experimental) public PgBackendConfig.Builder skipSchemaCreation(Boolean skipSchemaCreation)
      Sets the value of PgBackendConfig.getSkipSchemaCreation()
      Parameters:
      skipSchemaCreation - 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.
      Returns:
      this

    • skipTableCreation

      @Stability(Experimental) public PgBackendConfig.Builder skipTableCreation(Boolean skipTableCreation)
      Sets the value of PgBackendConfig.getSkipTableCreation()
      Parameters:
      skipTableCreation - 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.
      Returns:
      this

    • build

      @Stability(Experimental) public PgBackendConfig build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<PgBackendConfig>
      Returns:
      a new instance of PgBackendConfig
      Throws:
      NullPointerException - if any required attribute was not provided