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.
Initializers
import io.cdktn.cdktn.DataTerraformRemoteStatePg;
DataTerraformRemoteStatePg.Builder.create(Construct scope, java.lang.String id)
// .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();
| Name | Type | Description |
|---|
scope | software.constructs.Construct | No description. |
id | java.lang.String | No description. |
defaults | java.util.Map< java.lang.String, java.lang.Object > | No description. |
workspace | java.lang.String | No description. |
connStr | java.lang.String | Postgres connection string; |
schemaName | java.lang.String | Name of the automatically-managed Postgres schema, default to terraform_remote_state. |
skipIndexCreation | java.lang.Boolean | If set to true, the Postgres index must already exist. |
skipSchemaCreation | java.lang.Boolean | If set to true, the Postgres schema must already exist. |
skipTableCreation | java.lang.Boolean | If set to true, the Postgres table must already exist. |
scopeRequired
- Type: software.constructs.Construct
idRequired
defaultsOptional
- Type: java.util.Map< java.lang.String, java.lang.Object >
workspaceOptional
connStrRequired
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
Name of the automatically-managed Postgres schema, default to terraform_remote_state.
Can also be set using the PG_SCHEMA_NAME environment variable.
skipIndexCreationOptional
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
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
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.
Methods
| Name | Description |
|---|
toString | Returns a string representation of this construct. |
addOverride | No description. |
overrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
resetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
toHclTerraform | Adds this resource to the terraform JSON output. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
get | No description. |
getBoolean | No description. |
getList | No description. |
getNumber | No description. |
getString | No description. |
toString
public java.lang.String toString()
addOverride
public void addOverride(java.lang.String path, java.lang.Object value)
pathRequired
valueRequired
overrideLogicalId
public void overrideLogicalId(java.lang.String newLogicalId)
newLogicalIdRequired
The new logical ID to use for this stack element.
resetOverrideLogicalId
public void resetOverrideLogicalId()
public java.lang.Object toHclTerraform()
public java.lang.Object toMetadata()
public java.lang.Object toTerraform()
get
public IResolvable get(java.lang.String output)
outputRequired
getBoolean
public IResolvable getBoolean(java.lang.String output)
outputRequired
getList
public java.util.List<java.lang.String> getList(java.lang.String output)
outputRequired
getNumber
public java.lang.Number getNumber(java.lang.String output)
outputRequired
getString
public java.lang.String getString(java.lang.String output)
outputRequired
Static Functions
| Name | Description |
|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import io.cdktn.cdktn.DataTerraformRemoteStatePg;
DataTerraformRemoteStatePg.isConstruct(java.lang.Object x)
x is a construct.
Use this method instead of instanceof to properly detect Construct
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on
disk are seen as independent, completely different libraries. As a
consequence, the class Construct in each copy of the constructs library
is seen as a different class, and an instance of one class will not test as
instanceof the other class. npm install will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the constructs
library can be accidentally installed, and instanceof will behave
unpredictably. It is safest to avoid using instanceof, and using
this type-testing method instead.
xRequired
Any object.
import io.cdktn.cdktn.DataTerraformRemoteStatePg;
DataTerraformRemoteStatePg.isTerraformElement(java.lang.Object x)
xRequired
Properties
| Name | Type | Description |
|---|
node | software.constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | java.lang.String | No description. |
friendlyUniqueId | java.lang.String | No description. |
nodeRequired
- Type: software.constructs.Node
The tree node.
cdktfStackRequired
public TerraformStack getCdktfStack();
fqnRequired
public java.lang.String getFqn();
friendlyUniqueIdRequired
public java.lang.String getFriendlyUniqueId();
Constants
| Name | Type | Description |
|---|
tfResourceType | java.lang.String | No description. |
tfResourceTypeRequired
public java.lang.String getTfResourceType();
