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 

using Io.Cdktn;

new DataTerraformRemoteStatePgConfig {
    System.Collections.Generic.IDictionary<string, object> Defaults = null,
    string Workspace = null,
    string ConnStr,
    string SchemaName = null,
    bool SkipIndexCreation = null,
    bool SkipSchemaCreation = null,
    bool SkipTableCreation = null
};

​
Properties

NameTypeDescription
DefaultsSystem.Collections.Generic.IDictionary< string, object >No description.
WorkspacestringNo description.
ConnStrstringPostgres connection string;
SchemaNamestringName of the automatically-managed Postgres schema, default to terraform_remote_state.
SkipIndexCreationboolIf set to true, the Postgres index must already exist.
SkipSchemaCreationboolIf set to true, the Postgres schema must already exist.
SkipTableCreationboolIf set to true, the Postgres table must already exist.

​
DefaultsOptional 

public System.Collections.Generic.IDictionary<string, object> Defaults { get; set; }
  • Type: System.Collections.Generic.IDictionary< string, object >

​
WorkspaceOptional 

public string Workspace { get; set; }
  • Type: string

​
ConnStrRequired 

public string ConnStr { get; set; }
  • 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 

public string SchemaName { get; set; }
  • 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 

public bool SkipIndexCreation { get; set; }
  • 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 

public bool SkipSchemaCreation { get; set; }
  • 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 

public bool SkipTableCreation { get; set; }
  • 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.