Java: PgBackend - CDK Terrain (CDKTN)

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();

Name	Type	Description
`scope`	`software.constructs.Construct`	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.

`scope`^Required

Type: software.constructs.Construct

`connStr`^Required

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.

`schemaName`^Optional

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.

`skipIndexCreation`^Optional

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.

`skipSchemaCreation`^Optional

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.

`skipTableCreation`^Optional

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

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to 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`	No description.
`toMetadata`	No description.
`toTerraform`	Adds this resource to the terraform JSON output.
`getRemoteStateDataSource`	Creates a TerraformRemoteState resource that accesses this backend.

`toString`

public java.lang.String toString()

Returns a string representation of this construct.

`with`

public IConstruct with(IMixin... mixins)

Applies one or more mixins to this construct. Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: software.constructs.IMixin…

The mixins to apply.

`addOverride`

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

`path`^Required

Type: java.lang.String

`value`^Required

Type: java.lang.Object

`overrideLogicalId`

public void overrideLogicalId(java.lang.String newLogicalId)

Overrides the auto-generated logical ID with a specific ID.

`newLogicalId`^Required

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.

`scope`^Required

Type: software.constructs.Construct

`name`^Required

Type: java.lang.String

`_fromStack`^Required

Type: java.lang.String

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isTerraformElement`	No description.
`isBackend`	No 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.

`x`^Required

Type: java.lang.Object

Any object.

`isTerraformElement`

import io.cdktn.cdktn.PgBackend;

PgBackend.isTerraformElement(java.lang.Object x)

`x`^Required

Type: java.lang.Object

`isBackend`

import io.cdktn.cdktn.PgBackend;

PgBackend.isBackend(java.lang.Object x)

`x`^Required

Type: java.lang.Object

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.

`node`^Required

public Node getNode();

Type: software.constructs.Node

The tree node.

`cdktfStack`^Required

public TerraformStack getCdktfStack();

Type: TerraformStack

`fqn`^Required

public java.lang.String getFqn();

Type: java.lang.String

`friendlyUniqueId`^Required

public java.lang.String getFriendlyUniqueId();

Type: java.lang.String

​Initializers

​scopeRequired

​connStrRequired

​schemaNameOptional

​skipIndexCreationOptional

​skipSchemaCreationOptional

​skipTableCreationOptional

​Methods

​toString

​with

​mixinsRequired

​addOverride

​pathRequired

​valueRequired

​overrideLogicalId

​newLogicalIdRequired

​resetOverrideLogicalId

​toHclTerraform

​toMetadata

​toTerraform

​getRemoteStateDataSource

​scopeRequired

​nameRequired

​_fromStackRequired

​Static Functions

​isConstruct

​xRequired

​isTerraformElement

​xRequired

​isBackend

​xRequired

​Properties

​nodeRequired

​cdktfStackRequired

​fqnRequired

​friendlyUniqueIdRequired

Initializers

`scope`^Required

`connStr`^Required

`schemaName`^Optional

`skipIndexCreation`^Optional

`skipSchemaCreation`^Optional

`skipTableCreation`^Optional

Methods

`toString`

`with`

`mixins`^Required

`addOverride`

`path`^Required

`value`^Required

`overrideLogicalId`

`newLogicalId`^Required

`resetOverrideLogicalId`

`toHclTerraform`

`toMetadata`

`toTerraform`

`getRemoteStateDataSource`

`scope`^Required

`name`^Required

`_fromStack`^Required

Static Functions

`isConstruct`

`x`^Required

`isTerraformElement`

`x`^Required

`isBackend`

`x`^Required

Properties

`node`^Required

`cdktfStack`^Required

`fqn`^Required

`friendlyUniqueId`^Required