Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
Initializer 

import io.cdktn.cdktn.DataTerraformRemoteStatePgConfig;

DataTerraformRemoteStatePgConfig.builder()
//  .defaults(java.util.Map<java.lang.String, java.lang.Object>)
//  .workspace(java.lang.String)
    .connStr(java.lang.String)
//  .schemaName(java.lang.String)
//  .skipIndexCreation(java.lang.Boolean)
//  .skipSchemaCreation(java.lang.Boolean)
//  .skipTableCreation(java.lang.Boolean)
    .build();

​
Properties

NameTypeDescription
defaultsjava.util.Map< java.lang.String, java.lang.Object >No description.
workspacejava.lang.StringNo description.
connStrjava.lang.StringPostgres connection string;
schemaNamejava.lang.StringName of the automatically-managed Postgres schema, default to terraform_remote_state.
skipIndexCreationjava.lang.BooleanIf set to true, the Postgres index must already exist.
skipSchemaCreationjava.lang.BooleanIf set to true, the Postgres schema must already exist.
skipTableCreationjava.lang.BooleanIf set to true, the Postgres table must already exist.

​
defaultsOptional 

public java.util.Map<java.lang.String, java.lang.Object> getDefaults();
  • Type: java.util.Map< java.lang.String, java.lang.Object >

​
workspaceOptional 

public java.lang.String getWorkspace();
  • Type: java.lang.String

​
connStrRequired 

public java.lang.String getConnStr();
  • Type: java.lang.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.

​
schemaNameOptional 

public java.lang.String getSchemaName();
  • Type: java.lang.String
Name of the automatically-managed Postgres schema, default to terraform_remote_state. Can also be set using the PG_SCHEMA_NAME environment variable.

​
skipIndexCreationOptional 

public java.lang.Boolean getSkipIndexCreation();
  • Type: java.lang.Boolean
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.

​
skipSchemaCreationOptional 

public java.lang.Boolean getSkipSchemaCreation();
  • Type: java.lang.Boolean
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.

​
skipTableCreationOptional 

public java.lang.Boolean getSkipTableCreation();
  • Type: java.lang.Boolean
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.