Skip to main content

Initializer

import "github.com/open-constructs/cdk-terrain-go/cdktn"

&cdktn.DataTerraformRemoteStatePgConfig {
	Defaults: *map[string]interface{},
	Workspace: *string,
	ConnStr: *string,
	SchemaName: *string,
	SkipIndexCreation: *bool,
	SkipSchemaCreation: *bool,
	SkipTableCreation: *bool,
}

Properties

NameTypeDescription
Defaults*map[string]interface{}No description.
Workspace*stringNo description.
ConnStr*stringPostgres connection string;
SchemaName*stringName of the automatically-managed Postgres schema, default to terraform_remote_state.
SkipIndexCreation*boolIf set to true, the Postgres index must already exist.
SkipSchemaCreation*boolIf set to true, the Postgres schema must already exist.
SkipTableCreation*boolIf set to true, the Postgres table must already exist.

DefaultsOptional

Defaults *map[string]interface{}
  • Type: *map[string]interface{}

WorkspaceOptional

Workspace *string
  • Type: *string

ConnStrRequired

ConnStr *string
  • Type: *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

SchemaName *string
  • Type: *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

SkipIndexCreation *bool
  • Type: *bool
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

SkipSchemaCreation *bool
  • Type: *bool
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

SkipTableCreation *bool
  • Type: *bool
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.