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 { TerraformDataSource } from 'cdktn'
new TerraformDataSource(scope: Construct, id: string, config: TerraformResourceConfig)
| Name | Type | Description |
|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | TerraformResourceConfig | 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. |
getAnyMapAttribute | No description. |
getBooleanAttribute | No description. |
getBooleanMapAttribute | No description. |
getListAttribute | No description. |
getNumberAttribute | No description. |
getNumberListAttribute | No description. |
getNumberMapAttribute | No description. |
getStringAttribute | No description. |
getStringMapAttribute | No description. |
interpolationForAttribute | 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
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
getListAttribute
public getListAttribute(terraformAttribute: string): string[]
getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
getStringAttribute
public getStringAttribute(terraformAttribute: string): string
getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
Static Functions
| Name | Description |
|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformDataSource | No description. |
isConstruct
import { TerraformDataSource } from 'cdktn'
TerraformDataSource.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 { TerraformDataSource } from 'cdktn'
TerraformDataSource.isTerraformElement(x: any)
xRequired
import { TerraformDataSource } from 'cdktn'
TerraformDataSource.isTerraformDataSource(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. |
terraformMetaArguments | {[ key: string ]: any} | No description. |
terraformResourceType | string | No description. |
terraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
count | number | TerraformCount | No description. |
dependsOn | string[] | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
nodeRequired
public readonly node: Node;
cdktfStackRequired
public readonly cdktfStack: TerraformStack;
fqnRequired
public readonly fqn: string;
friendlyUniqueIdRequired
public readonly friendlyUniqueId: string;
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
public readonly terraformResourceType: string;
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
countOptional
public readonly count: number | TerraformCount;
dependsOnOptional
public readonly dependsOn: string[];
forEachOptional
public readonly forEach: ITerraformIterator;
lifecycleOptional
public readonly lifecycle: TerraformResourceLifecycle;
providerOptional
public readonly provider: TerraformProvider;
