Skip to main content

​
Initializers 

import io.cdktn.cdktn.PgBackend;

PgBackend.Builder.create(Construct scope)
    .connStr(java.lang.String)
//  .schemaName(java.lang.String)
//  .skipIndexCreation(java.lang.Boolean)
//  .skipSchemaCreation(java.lang.Boolean)
//  .skipTableCreation(java.lang.Boolean)
    .build();
NameTypeDescription
scopesoftware.constructs.ConstructNo 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.

​
scopeRequired

  • Type: software.constructs.Construct

​
connStrRequired

  • 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

  • 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

  • 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

  • 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

  • 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.

​
Methods

NameDescription
toStringReturns a string representation of this construct.
addOverrideNo description.
overrideLogicalIdOverrides the auto-generated logical ID with a specific ID.
resetOverrideLogicalIdResets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraformNo description.
toMetadataNo description.
toTerraformAdds this resource to the terraform JSON output.
getRemoteStateDataSourceCreates a TerraformRemoteState resource that accesses this backend.

​
toString 

public java.lang.String toString()
Returns a string representation of this construct.

​
addOverride 

public void addOverride(java.lang.String path, java.lang.Object value)

​
pathRequired

  • Type: java.lang.String

​
valueRequired

  • Type: java.lang.Object

​
overrideLogicalId 

public void overrideLogicalId(java.lang.String newLogicalId)
Overrides the auto-generated logical ID with a specific ID.

​
newLogicalIdRequired

  • Type: java.lang.String
The new logical ID to use for this stack element.

​
resetOverrideLogicalId 

public void resetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.

​
toHclTerraform 

public java.lang.Object toHclTerraform()

​
toMetadata 

public java.lang.Object toMetadata()

​
toTerraform 

public java.lang.Object toTerraform()
Adds this resource to the terraform JSON output.

​
getRemoteStateDataSource 

public TerraformRemoteState getRemoteStateDataSource(Construct scope, java.lang.String name, java.lang.String _fromStack)
Creates a TerraformRemoteState resource that accesses this backend.

​
scopeRequired

  • Type: software.constructs.Construct

​
nameRequired

  • Type: java.lang.String

​
_fromStackRequired

  • Type: java.lang.String

​
Static Functions

NameDescription
isConstructChecks if x is a construct.
isTerraformElementNo description.
isBackendNo description.

​
isConstruct 

import io.cdktn.cdktn.PgBackend;

PgBackend.isConstruct(java.lang.Object x)
Checks if 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

  • Type: java.lang.Object
Any object.

​
isTerraformElement 

import io.cdktn.cdktn.PgBackend;

PgBackend.isTerraformElement(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
isBackend 

import io.cdktn.cdktn.PgBackend;

PgBackend.isBackend(java.lang.Object x)

​
xRequired

  • Type: java.lang.Object

​
Properties

NameTypeDescription
nodesoftware.constructs.NodeThe tree node.
cdktfStackTerraformStackNo description.
fqnjava.lang.StringNo description.
friendlyUniqueIdjava.lang.StringNo description.

​
nodeRequired 

public Node getNode();
  • Type: software.constructs.Node
The tree node.

​
cdktfStackRequired 

public TerraformStack getCdktfStack();

​
fqnRequired 

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

​
friendlyUniqueIdRequired 

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