Class DataTerraformRemoteStatePg.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<DataTerraformRemoteStatePg>
- Enclosing class:
DataTerraformRemoteStatePg
DataTerraformRemoteStatePg
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
(experimental) Postgres connection string;schemaName
(String schemaName) (experimental) Name of the automatically-managed Postgres schema, default to terraform_remote_state.skipIndexCreation
(Boolean skipIndexCreation) (experimental) If set to true, the Postgres index must already exist.skipSchemaCreation
(Boolean skipSchemaCreation) (experimental) If set to true, the Postgres schema must already exist.skipTableCreation
(Boolean skipTableCreation) (experimental) If set to true, the Postgres table must already exist.
-
Method Details
-
create
@Stability(Experimental) public static DataTerraformRemoteStatePg.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
DataTerraformRemoteStatePg.Builder
.
-
defaults
@Stability(Experimental) public DataTerraformRemoteStatePg.Builder defaults(Map<String, ? extends Object> defaults) - Parameters:
defaults
- This parameter is required.- Returns:
this
-
workspace
- Parameters:
workspace
- This parameter is required.- Returns:
this
-
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
(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 DataTerraformRemoteStatePg.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 DataTerraformRemoteStatePg.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 DataTerraformRemoteStatePg.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
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<DataTerraformRemoteStatePg>
- Returns:
- a newly built instance of
DataTerraformRemoteStatePg
.
-