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 { DataTerraformRemoteStatePg } from 'cdktn'
new DataTerraformRemoteStatePg(scope: Construct, id: string, config: DataTerraformRemoteStatePgConfig)
| Name | Type | Description |
|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStatePgConfig | No description. |
scopeRequired
- Type: constructs.Construct
idRequired
configRequired
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 toString(): string
addOverride
public addOverride(path: string, value: any): void
pathRequired
valueRequired
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
newLogicalIdRequired
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
public toHclTerraform(): any
public toTerraform(): any
get
public get(output: string): IResolvable
outputRequired
getBoolean
public getBoolean(output: string): IResolvable
outputRequired
getList
public getList(output: string): string[]
outputRequired
getNumber
public getNumber(output: string): number
outputRequired
getString
public getString(output: string): string
outputRequired
Static Functions
| Name | Description |
|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStatePg } from 'cdktn'
DataTerraformRemoteStatePg.isConstruct(x: any)
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 { DataTerraformRemoteStatePg } from 'cdktn'
DataTerraformRemoteStatePg.isTerraformElement(x: any)
xRequired
Properties
| Name | Type | Description |
|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
nodeRequired
public readonly node: Node;
cdktfStackRequired
public readonly cdktfStack: TerraformStack;
fqnRequired
public readonly fqn: string;
friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
Constants
| Name | Type | Description |
|---|
tfResourceType | string | No description. |
tfResourceTypeRequired
public readonly tfResourceType: string;
