Terraform
Typescript: Constructs
App
Represents a cdktf application.
Initializers
import { App } from 'cdktf'
new App(config?: AppConfig)
config
Optional
- Type: AppConfig
configuration.
Methods
Name | Description |
---|---|
toString | Returns a string representation of this construct. |
crossStackReference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. |
synth | Synthesizes all resources to the output directory. |
toString
public toString(): string
Returns a string representation of this construct.
crossStackReference
public crossStackReference(fromStack: TerraformStack, toStack: TerraformStack, identifier: string): string
Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources.
fromStack
Required
- Type: TerraformStack
toStack
Required
- Type: TerraformStack
identifier
Required
- Type: string
synth
public synth(): void
Synthesizes all resources to the output directory.
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isApp | No description. |
of | No description. |
isConstruct
import { App } from 'cdktf'
App.isConstruct(x: any)
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: any
Any object.
isApp
import { App } from 'cdktf'
App.isApp(x: any)
x
Required
- Type: any
of
import { App } from 'cdktf'
App.of(construct: IConstruct)
construct
Required
- Type: constructs.IConstruct
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
hclOutput | boolean | No description. |
manifest | Manifest | No description. |
outdir | string | The output directory into which resources will be synthesized. |
skipBackendValidation | boolean | Whether to skip backend validation during synthesis of the app. |
skipValidation | boolean | Whether to skip all validations during synthesis of the app. |
targetStackId | string | The stack which will be synthesized. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
hclOutput
Required
public readonly hclOutput: boolean;
- Type: boolean
manifest
Required
public readonly manifest: Manifest;
- Type: Manifest
outdir
Required
public readonly outdir: string;
- Type: string
The output directory into which resources will be synthesized.
skipBackendValidation
Required
public readonly skipBackendValidation: boolean;
- Type: boolean
Whether to skip backend validation during synthesis of the app.
skipValidation
Required
public readonly skipValidation: boolean;
- Type: boolean
Whether to skip all validations during synthesis of the app.
targetStackId
Optional
public readonly targetStackId: string;
- Type: string
The stack which will be synthesized.
If not set, all stacks will be synthesized.
AzurermBackend
Initializers
import { AzurermBackend } from 'cdktf'
new AzurermBackend(scope: Construct, props: AzurermBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | AzurermBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: AzurermBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { AzurermBackend } from 'cdktf'
AzurermBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { AzurermBackend } from 'cdktf'
AzurermBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { AzurermBackend } from 'cdktf'
AzurermBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
CloudBackend
The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.
Initializers
import { CloudBackend } from 'cdktf'
new CloudBackend(scope: Construct, props: CloudBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | CloudBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: CloudBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { CloudBackend } from 'cdktf'
CloudBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { CloudBackend } from 'cdktf'
CloudBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { CloudBackend } from 'cdktf'
CloudBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
ConsulBackend
Initializers
import { ConsulBackend } from 'cdktf'
new ConsulBackend(scope: Construct, props: ConsulBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | ConsulBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: ConsulBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { ConsulBackend } from 'cdktf'
ConsulBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { ConsulBackend } from 'cdktf'
ConsulBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { ConsulBackend } from 'cdktf'
ConsulBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
CosBackend
Initializers
import { CosBackend } from 'cdktf'
new CosBackend(scope: Construct, props: CosBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | CosBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: CosBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { CosBackend } from 'cdktf'
CosBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { CosBackend } from 'cdktf'
CosBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { CosBackend } from 'cdktf'
CosBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
DataResource
The DataResource implements the standard resource lifecycle, but does not directly take any other actions.
You can use the DataResource resource without requiring or configuring a provider.
The DataResource resource is useful for storing values which need to follow a manage resource lifecycle, and for triggering provisioners when there is no other logical managed resource in which to place them.
It requires Terraform 1.4 or later.
It is also possible to generate these bindings by adding "terraform.io/builtin/terraform" to the "terraformProviders" key in your cdktf.json file and running "cdktf get".
https://developer.hashicorp.com/terraform/language/resources/terraform-data
Initializers
import { DataResource } from 'cdktf'
new DataResource(scope: Construct, id: string, config?: DataConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | The scope in which to define this construct. |
id | string | The scoped construct ID. |
config | DataConfig | No description. |
scope
Required
- Type: constructs.Construct
The scope in which to define this construct.
id
Required
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
config
Optional
- Type: DataConfig
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 | No description. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
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. |
hasResourceMove | No description. |
importFrom | No description. |
interpolationForAttribute | No description. |
moveFromId | Move the resource corresponding to "id" to this resource. |
moveTo | Moves this resource to the target resource given by moveTarget. |
moveToId | Moves this resource to the resource corresponding to "id". |
resetInput | No description. |
resetTriggersReplace | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
addMoveTarget
public addMoveTarget(moveTarget: string): void
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
moveTarget
Required
- Type: string
The string move target that will correspond to this resource.
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttribute
Required
- Type: string
getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttribute
Required
- Type: string
getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttribute
Required
- Type: string
getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttribute
Required
- Type: string
getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttribute
Required
- Type: string
getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttribute
Required
- Type: string
getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttribute
Required
- Type: string
getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttribute
Required
- Type: string
hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
id
Required
- Type: string
provider
Optional
- Type: TerraformProvider
interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttribute
Required
- Type: string
moveFromId
public moveFromId(id: string): void
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
id
Required
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
moveTo
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
moveTarget
Required
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
index
Optional
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
moveToId
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
id
Required
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
resetInput
public resetInput(): void
resetTriggersReplace
public resetTriggersReplace(): void
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformResource | No description. |
generateConfigForImport | Generates CDKTF code for importing a Data resource upon running "cdktf plan < stack-name >". |
isConstruct
import { DataResource } from 'cdktf'
DataResource.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataResource } from 'cdktf'
DataResource.isTerraformElement(x: any)
x
Required
- Type: any
isTerraformResource
import { DataResource } from 'cdktf'
DataResource.isTerraformResource(x: any)
x
Required
- Type: any
generateConfigForImport
import { DataResource } from 'cdktf'
DataResource.generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: TerraformProvider)
Generates CDKTF code for importing a Data resource upon running "cdktf plan < stack-name >".
scope
Required
- Type: constructs.Construct
The scope in which to define this construct.
importToId
Required
- Type: string
The construct id used in the generated config for the Data to import.
importFromId
Required
- Type: string
The id of the existing Data that should be imported.
Refer to the {@link https://terraform.io/providers/builtin/terraform/latest/docs/resources/data#import import section} in the documentation of this resource for the id to use
provider
Optional
- Type: TerraformProvider
? Optional instance of the provider where the Data to import is found.
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. |
connection | SSHProvisionerConnection | WinrmProvisionerConnection | No description. |
count | number | TerraformCount | No description. |
dependsOn | string[] | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
provisioners | FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[] | No description. |
id | string | No description. |
output | AnyMap | No description. |
inputInput | {[ key: string ]: any} | No description. |
triggersReplaceInput | {[ key: string ]: any} | No description. |
input | {[ key: string ]: any} | (Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply. |
triggersReplace | {[ key: string ]: any} | (Optional) A value which is stored in the instance state, and will force replacement when the value changes. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
terraformMetaArguments
Required
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
terraformResourceType
Required
public readonly terraformResourceType: string;
- Type: string
terraformGeneratorMetadata
Optional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
connection
Optional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
count
Optional
public readonly count: number | TerraformCount;
- Type: number | TerraformCount
dependsOn
Optional
public readonly dependsOn: string[];
- Type: string[]
forEach
Optional
public readonly forEach: ITerraformIterator;
- Type: ITerraformIterator
lifecycle
Optional
public readonly lifecycle: TerraformResourceLifecycle;
provider
Optional
public readonly provider: TerraformProvider;
- Type: TerraformProvider
provisioners
Optional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]
id
Required
public readonly id: string;
- Type: string
output
Required
public readonly output: AnyMap;
- Type: AnyMap
inputInput
Optional
public readonly inputInput: {[ key: string ]: any};
- Type: {[ key: string ]: any}
triggersReplaceInput
Optional
public readonly triggersReplaceInput: {[ key: string ]: any};
- Type: {[ key: string ]: any}
input
Required
public readonly input: {[ key: string ]: any};
- Type: {[ key: string ]: any}
(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
https://developer.hashicorp.com/terraform/language/resources/terraform-data#input
triggersReplace
Required
public readonly triggersReplace: {[ key: string ]: any};
- Type: {[ key: string ]: any}
(Optional) A value which is stored in the instance state, and will force replacement when the value changes.
https://developer.hashicorp.com/terraform/language/resources/terraform-data#triggers_replace
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteState
Initializers
import { DataTerraformRemoteState } from 'cdktf'
new DataTerraformRemoteState(scope: Construct, id: string, config: DataTerraformRemoteStateRemoteConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateRemoteConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteState } from 'cdktf'
DataTerraformRemoteState.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteState } from 'cdktf'
DataTerraformRemoteState.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateAzurerm
Initializers
import { DataTerraformRemoteStateAzurerm } from 'cdktf'
new DataTerraformRemoteStateAzurerm(scope: Construct, id: string, config: DataTerraformRemoteStateAzurermConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateAzurermConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateAzurerm } from 'cdktf'
DataTerraformRemoteStateAzurerm.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateAzurerm } from 'cdktf'
DataTerraformRemoteStateAzurerm.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateConsul
Initializers
import { DataTerraformRemoteStateConsul } from 'cdktf'
new DataTerraformRemoteStateConsul(scope: Construct, id: string, config: DataTerraformRemoteStateConsulConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateConsulConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateConsul } from 'cdktf'
DataTerraformRemoteStateConsul.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateConsul } from 'cdktf'
DataTerraformRemoteStateConsul.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateCos
Initializers
import { DataTerraformRemoteStateCos } from 'cdktf'
new DataTerraformRemoteStateCos(scope: Construct, id: string, config: DataTerraformRemoteStateCosConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateCosConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateCos } from 'cdktf'
DataTerraformRemoteStateCos.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateCos } from 'cdktf'
DataTerraformRemoteStateCos.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateGcs
Initializers
import { DataTerraformRemoteStateGcs } from 'cdktf'
new DataTerraformRemoteStateGcs(scope: Construct, id: string, config: DataTerraformRemoteStateGcsConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateGcsConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateGcs } from 'cdktf'
DataTerraformRemoteStateGcs.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateGcs } from 'cdktf'
DataTerraformRemoteStateGcs.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateHttp
Initializers
import { DataTerraformRemoteStateHttp } from 'cdktf'
new DataTerraformRemoteStateHttp(scope: Construct, id: string, config: DataTerraformRemoteStateHttpConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateHttpConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateHttp } from 'cdktf'
DataTerraformRemoteStateHttp.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateHttp } from 'cdktf'
DataTerraformRemoteStateHttp.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateLocal
Initializers
import { DataTerraformRemoteStateLocal } from 'cdktf'
new DataTerraformRemoteStateLocal(scope: Construct, id: string, config: DataTerraformRemoteStateLocalConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateLocalConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateLocal } from 'cdktf'
DataTerraformRemoteStateLocal.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateLocal } from 'cdktf'
DataTerraformRemoteStateLocal.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateOss
Initializers
import { DataTerraformRemoteStateOss } from 'cdktf'
new DataTerraformRemoteStateOss(scope: Construct, id: string, config: DataTerraformRemoteStateOssConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateOssConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateOss } from 'cdktf'
DataTerraformRemoteStateOss.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateOss } from 'cdktf'
DataTerraformRemoteStateOss.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStatePg
Initializers
import { DataTerraformRemoteStatePg } from 'cdktf'
new DataTerraformRemoteStatePg(scope: Construct, id: string, config: DataTerraformRemoteStatePgConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStatePgConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStatePg } from 'cdktf'
DataTerraformRemoteStatePg.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStatePg } from 'cdktf'
DataTerraformRemoteStatePg.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateS3
Initializers
import { DataTerraformRemoteStateS3 } from 'cdktf'
new DataTerraformRemoteStateS3(scope: Construct, id: string, config: DataTerraformRemoteStateS3Config)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateS3Config | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { DataTerraformRemoteStateS3 } from 'cdktf'
DataTerraformRemoteStateS3.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { DataTerraformRemoteStateS3 } from 'cdktf'
DataTerraformRemoteStateS3.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
DataTerraformRemoteStateSwift
Initializers
import { DataTerraformRemoteStateSwift } from 'cdktf'
new DataTerraformRemoteStateSwift(scope: Construct, id: string, config: DataTerraformRemoteStateSwiftConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateSwiftConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
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
toString
public toString(): string
Returns a string representation of this construct.
addOverride
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
toMetadata
public toMetadata(): any
toTerraform
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
isConstruct
import { DataTerraformRemoteStateSwift } from 'cdktf'
DataTerraformRemoteStateSwift.isConstruct(x: any)
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: any
Any object.
isTerraformElement
isTerraformElement
import { DataTerraformRemoteStateSwift } from 'cdktf'
DataTerraformRemoteStateSwift.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
node
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
cdktfStack
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
fqn
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
friendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
tfResourceType
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly tfResourceType: string;
- Type: string
GcsBackend
Initializers
import { GcsBackend } from 'cdktf'
new GcsBackend(scope: Construct, props: GcsBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | GcsBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: GcsBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { GcsBackend } from 'cdktf'
GcsBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { GcsBackend } from 'cdktf'
GcsBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { GcsBackend } from 'cdktf'
GcsBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
HttpBackend
Initializers
import { HttpBackend } from 'cdktf'
new HttpBackend(scope: Construct, props: HttpBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | HttpBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: HttpBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { HttpBackend } from 'cdktf'
HttpBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { HttpBackend } from 'cdktf'
HttpBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { HttpBackend } from 'cdktf'
HttpBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
ImportableResource
Class used to represent an importable resource.
Initializers
import { ImportableResource } from 'cdktf'
new ImportableResource(scope: Construct, name: string, config: IImportableConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
name | string | No description. |
config | IImportableConfig | No description. |
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
config
Required
- Type: IImportableConfig
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 | No description. |
toMetadata | No description. |
toTerraform | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { ImportableResource } from 'cdktf'
ImportableResource.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { ImportableResource } from 'cdktf'
ImportableResource.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
LocalBackend
Initializers
import { LocalBackend } from 'cdktf'
new LocalBackend(scope: Construct, props?: LocalBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | LocalBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Optional
- Type: LocalBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { LocalBackend } from 'cdktf'
LocalBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { LocalBackend } from 'cdktf'
LocalBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { LocalBackend } from 'cdktf'
LocalBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
OssBackend
Initializers
import { OssBackend } from 'cdktf'
new OssBackend(scope: Construct, props: OssBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | OssBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: OssBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { OssBackend } from 'cdktf'
OssBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { OssBackend } from 'cdktf'
OssBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { OssBackend } from 'cdktf'
OssBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
PgBackend
Initializers
import { PgBackend } from 'cdktf'
new PgBackend(scope: Construct, props: PgBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | PgBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: PgBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { PgBackend } from 'cdktf'
PgBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { PgBackend } from 'cdktf'
PgBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { PgBackend } from 'cdktf'
PgBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
RemoteBackend
Initializers
import { RemoteBackend } from 'cdktf'
new RemoteBackend(scope: Construct, props: RemoteBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | RemoteBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: RemoteBackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { RemoteBackend } from 'cdktf'
RemoteBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { RemoteBackend } from 'cdktf'
RemoteBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { RemoteBackend } from 'cdktf'
RemoteBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Resource
- Implements: IResource
A construct which represents a resource.
Initializers
import { Resource } from 'cdktf'
new Resource(scope: Construct, id: string)
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
Methods
Name | Description |
---|---|
toString | Returns a string representation of this construct. |
toString
toString
public toString(): string
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isConstruct
isConstruct
import { Resource } from 'cdktf'
Resource.isConstruct(x: any)
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: any
Any object.
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
stack | TerraformStack | The stack in which this resource is defined. |
node
Required
node
- Deprecated: - Please use Construct from the constructs package instead.
public readonly node: Node;
- Type: constructs.Node
The tree node.
stack
Required
stack
- Deprecated: - Please use Construct from the constructs package instead.
public readonly stack: TerraformStack;
- Type: TerraformStack
The stack in which this resource is defined.
S3Backend
Initializers
import { S3Backend } from 'cdktf'
new S3Backend(scope: Construct, props: S3BackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | S3BackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: S3BackendConfig
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { S3Backend } from 'cdktf'
S3Backend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { S3Backend } from 'cdktf'
S3Backend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { S3Backend } from 'cdktf'
S3Backend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
SwiftBackend
Initializers
import { SwiftBackend } from 'cdktf'
new SwiftBackend(scope: Construct, props: SwiftBackendConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | SwiftBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: SwiftBackendConfig
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 | No description. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
toString
toString
public toString(): string
Returns a string representation of this construct.
addOverride
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
toHclTerraform
public toHclTerraform(): any
toMetadata
toMetadata
public toMetadata(): any
toTerraform
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, _fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
_fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
isConstruct
import { SwiftBackend } from 'cdktf'
SwiftBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
isTerraformElement
import { SwiftBackend } from 'cdktf'
SwiftBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
isBackend
import { SwiftBackend } from 'cdktf'
SwiftBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
node
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
cdktfStack
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
fqn
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
friendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public readonly friendlyUniqueId: string;
- Type: string
TerraformAsset
Initializers
import { TerraformAsset } from 'cdktf'
new TerraformAsset(scope: Construct, id: string, config: TerraformAssetConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | TerraformAssetConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
- Type: TerraformAssetConfig
Methods
Name | Description |
---|---|
toString | Returns a string representation of this construct. |
toString
public toString(): string
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isConstruct
import { TerraformAsset } from 'cdktf'
TerraformAsset.isConstruct(x: any)
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: any
Any object.
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
fileName | string | Name of the asset. |
path | string | The path relative to the root of the terraform directory in posix format Use this property to reference the asset. |
assetHash | string | No description. |
type | AssetType | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
fileName
Required
public readonly fileName: string;
- Type: string
Name of the asset.
path
Required
public readonly path: string;
- Type: string
The path relative to the root of the terraform directory in posix format Use this property to reference the asset.
assetHash
Required
public readonly assetHash: string;
- Type: string
type
Required
public readonly type: AssetType;
- Type: AssetType
TerraformBackend
Initializers
import { TerraformBackend } from 'cdktf'
new TerraformBackend(scope: Construct, id: string, name: string)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
name | string | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
name
Required
- Type: string
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 | 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 toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
public getRemoteStateDataSource(scope: Construct, name: string, fromStack: string): TerraformRemoteState
Creates a TerraformRemoteState resource that accesses this backend.
scope
Required
- Type: constructs.Construct
name
Required
- Type: string
fromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isBackend | No description. |
isConstruct
import { TerraformBackend } from 'cdktf'
TerraformBackend.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformBackend } from 'cdktf'
TerraformBackend.isTerraformElement(x: any)
x
Required
- Type: any
isBackend
import { TerraformBackend } from 'cdktf'
TerraformBackend.isBackend(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
TerraformDataSource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
import { TerraformDataSource } from 'cdktf'
new TerraformDataSource(scope: Construct, id: string, config: TerraformResourceConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | TerraformResourceConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
- Type: TerraformResourceConfig
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttribute
Required
- Type: string
getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttribute
Required
- Type: string
getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttribute
Required
- Type: string
getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttribute
Required
- Type: string
getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttribute
Required
- Type: string
getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttribute
Required
- Type: string
getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttribute
Required
- Type: string
getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttribute
Required
- Type: string
interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttribute
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformDataSource | No description. |
isConstruct
import { TerraformDataSource } from 'cdktf'
TerraformDataSource.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformDataSource } from 'cdktf'
TerraformDataSource.isTerraformElement(x: any)
x
Required
- Type: any
isTerraformDataSource
import { TerraformDataSource } from 'cdktf'
TerraformDataSource.isTerraformDataSource(x: any)
x
Required
- Type: any
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. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
terraformMetaArguments
Required
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
terraformResourceType
Required
public readonly terraformResourceType: string;
- Type: string
terraformGeneratorMetadata
Optional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
count
Optional
public readonly count: number | TerraformCount;
- Type: number | TerraformCount
dependsOn
Optional
public readonly dependsOn: string[];
- Type: string[]
forEach
Optional
public readonly forEach: ITerraformIterator;
- Type: ITerraformIterator
lifecycle
Optional
public readonly lifecycle: TerraformResourceLifecycle;
provider
Optional
public readonly provider: TerraformProvider;
- Type: TerraformProvider
TerraformElement
Initializers
import { TerraformElement } from 'cdktf'
new TerraformElement(scope: Construct, id: string, elementType?: string)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
elementType | string | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
elementType
Optional
- Type: string
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 | No description. |
toMetadata | No description. |
toTerraform | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { TerraformElement } from 'cdktf'
TerraformElement.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformElement } from 'cdktf'
TerraformElement.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
TerraformHclModule
Initializers
import { TerraformHclModule } from 'cdktf'
new TerraformHclModule(scope: Construct, id: string, options: TerraformHclModuleConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
options | TerraformHclModuleConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
options
Required
- Type: TerraformHclModuleConfig
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 | No description. |
toMetadata | No description. |
toTerraform | No description. |
addProvider | No description. |
getString | No description. |
interpolationForOutput | No description. |
get | No description. |
getBoolean | No description. |
getList | No description. |
getNumber | No description. |
set | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
addProvider
public addProvider(provider: TerraformProvider | TerraformModuleProvider): void
provider
Required
getString
public getString(output: string): string
output
Required
- Type: string
interpolationForOutput
public interpolationForOutput(moduleOutput: string): IResolvable
moduleOutput
Required
- Type: string
get
public get(output: string): any
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
set
public set(variable: string, value: any): void
variable
Required
- Type: string
value
Required
- Type: any
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { TerraformHclModule } from 'cdktf'
TerraformHclModule.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformHclModule } from 'cdktf'
TerraformHclModule.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
source | string | No description. |
providers | TerraformProvider | TerraformModuleProvider[] | No description. |
skipAssetCreationFromLocalModules | boolean | No description. |
version | string | No description. |
dependsOn | string[] | No description. |
forEach | ITerraformIterator | No description. |
variables | {[ key: string ]: any} | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
source
Required
public readonly source: string;
- Type: string
providers
Optional
public readonly providers: TerraformProvider | TerraformModuleProvider[];
- Type: TerraformProvider | TerraformModuleProvider[]
skipAssetCreationFromLocalModules
Optional
public readonly skipAssetCreationFromLocalModules: boolean;
- Type: boolean
version
Optional
public readonly version: string;
- Type: string
dependsOn
Optional
public readonly dependsOn: string[];
- Type: string[]
forEach
Optional
public readonly forEach: ITerraformIterator;
- Type: ITerraformIterator
variables
Optional
public readonly variables: {[ key: string ]: any};
- Type: {[ key: string ]: any}
TerraformLocal
- Implements: ITerraformAddressable
Initializers
import { TerraformLocal } from 'cdktf'
new TerraformLocal(scope: Construct, id: string, expression: any)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
expression | any | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
expression
Required
- Type: any
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 | No description. |
toMetadata | No description. |
toTerraform | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { TerraformLocal } from 'cdktf'
TerraformLocal.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformLocal } from 'cdktf'
TerraformLocal.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
asAnyMap | {[ key: string ]: any} | No description. |
asBoolean | IResolvable | No description. |
asBooleanMap | {[ key: string ]: boolean} | No description. |
asList | string[] | No description. |
asNumber | number | No description. |
asNumberMap | {[ key: string ]: number} | No description. |
asString | string | No description. |
asStringMap | {[ key: string ]: string} | No description. |
expression | any | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
asAnyMap
Required
public readonly asAnyMap: {[ key: string ]: any};
- Type: {[ key: string ]: any}
asBoolean
Required
public readonly asBoolean: IResolvable;
- Type: IResolvable
asBooleanMap
Required
public readonly asBooleanMap: {[ key: string ]: boolean};
- Type: {[ key: string ]: boolean}
asList
Required
public readonly asList: string[];
- Type: string[]
asNumber
Required
public readonly asNumber: number;
- Type: number
asNumberMap
Required
public readonly asNumberMap: {[ key: string ]: number};
- Type: {[ key: string ]: number}
asString
Required
public readonly asString: string;
- Type: string
asStringMap
Required
public readonly asStringMap: {[ key: string ]: string};
- Type: {[ key: string ]: string}
expression
Required
public readonly expression: any;
- Type: any
TerraformModule
- Implements: ITerraformDependable
TerraformModule can be used to reference a local terraform module or a module from the Terraform Registry.
It should be used if you can not use generated bindings for the module as you would get by adding the module to your cdktf.json files "terraformModules" array and running cdktf get.
This class is not creating a Terraform module to be used outside of CDKTF. If you want to bundle certain resources together like you would do with a Terraform module, you should use Constructs instead, see http://cdk.tf/constructs for more details.
Initializers
import { TerraformModule } from 'cdktf'
new TerraformModule(scope: Construct, id: string, options: TerraformModuleConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
options | TerraformModuleConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
options
Required
- Type: TerraformModuleConfig
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 | No description. |
toMetadata | No description. |
toTerraform | No description. |
addProvider | No description. |
getString | No description. |
interpolationForOutput | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
addProvider
public addProvider(provider: TerraformProvider | TerraformModuleProvider): void
provider
Required
getString
public getString(output: string): string
output
Required
- Type: string
interpolationForOutput
public interpolationForOutput(moduleOutput: string): IResolvable
moduleOutput
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { TerraformModule } from 'cdktf'
TerraformModule.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformModule } from 'cdktf'
TerraformModule.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
source | string | No description. |
providers | TerraformProvider | TerraformModuleProvider[] | No description. |
skipAssetCreationFromLocalModules | boolean | No description. |
version | string | No description. |
dependsOn | string[] | No description. |
forEach | ITerraformIterator | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
source
Required
public readonly source: string;
- Type: string
providers
Optional
public readonly providers: TerraformProvider | TerraformModuleProvider[];
- Type: TerraformProvider | TerraformModuleProvider[]
skipAssetCreationFromLocalModules
Optional
public readonly skipAssetCreationFromLocalModules: boolean;
- Type: boolean
version
Optional
public readonly version: string;
- Type: string
dependsOn
Optional
public readonly dependsOn: string[];
- Type: string[]
forEach
Optional
public readonly forEach: ITerraformIterator;
- Type: ITerraformIterator
TerraformOutput
Initializers
import { TerraformOutput } from 'cdktf'
new TerraformOutput(scope: Construct, id: string, config: TerraformOutputConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | TerraformOutputConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
- Type: TerraformOutputConfig
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 | No description. |
toMetadata | No description. |
toTerraform | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformOutput | No description. |
isConstruct
import { TerraformOutput } from 'cdktf'
TerraformOutput.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformOutput } from 'cdktf'
TerraformOutput.isTerraformElement(x: any)
x
Required
- Type: any
isTerraformOutput
import { TerraformOutput } from 'cdktf'
TerraformOutput.isTerraformOutput(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
staticId | boolean | No description. |
value | any | No description. |
dependsOn | ITerraformDependable[] | No description. |
description | string | No description. |
precondition | Precondition | No description. |
sensitive | boolean | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
staticId
Required
public readonly staticId: boolean;
- Type: boolean
value
Required
public readonly value: any;
- Type: any
dependsOn
Optional
public readonly dependsOn: ITerraformDependable[];
- Type: ITerraformDependable[]
description
Optional
public readonly description: string;
- Type: string
precondition
Optional
public readonly precondition: Precondition;
- Type: Precondition
sensitive
Optional
public readonly sensitive: boolean;
- Type: boolean
TerraformProvider
Initializers
import { TerraformProvider } from 'cdktf'
new TerraformProvider(scope: Construct, id: string, config: TerraformProviderConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | TerraformProviderConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
- Type: TerraformProviderConfig
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 | No description. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformProvider | No description. |
isConstruct
import { TerraformProvider } from 'cdktf'
TerraformProvider.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformProvider } from 'cdktf'
TerraformProvider.isTerraformElement(x: any)
x
Required
- Type: any
isTerraformProvider
import { TerraformProvider } from 'cdktf'
TerraformProvider.isTerraformProvider(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
metaAttributes | {[ key: string ]: any} | No description. |
terraformResourceType | string | No description. |
terraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
terraformProviderSource | string | No description. |
alias | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
metaAttributes
Required
public readonly metaAttributes: {[ key: string ]: any};
- Type: {[ key: string ]: any}
terraformResourceType
Required
public readonly terraformResourceType: string;
- Type: string
terraformGeneratorMetadata
Optional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
terraformProviderSource
Optional
public readonly terraformProviderSource: string;
- Type: string
alias
Optional
public readonly alias: string;
- Type: string
TerraformRemoteState
- Implements: ITerraformAddressable
Initializers
import { TerraformRemoteState } from 'cdktf'
new TerraformRemoteState(scope: Construct, id: string, backend: string, config: DataTerraformRemoteStateConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
backend | string | No description. |
config | DataTerraformRemoteStateConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
backend
Required
- Type: string
config
Required
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
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
Adds this resource to the terraform JSON output.
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
get
public get(output: string): IResolvable
output
Required
- Type: string
getBoolean
public getBoolean(output: string): IResolvable
output
Required
- Type: string
getList
public getList(output: string): string[]
output
Required
- Type: string
getNumber
public getNumber(output: string): number
output
Required
- Type: string
getString
public getString(output: string): string
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { TerraformRemoteState } from 'cdktf'
TerraformRemoteState.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformRemoteState } from 'cdktf'
TerraformRemoteState.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
public readonly tfResourceType: string;
- Type: string
TerraformResource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
import { TerraformResource } from 'cdktf'
new TerraformResource(scope: Construct, id: string, config: TerraformResourceConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | TerraformResourceConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
- Type: TerraformResourceConfig
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 | No description. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
addMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
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. |
hasResourceMove | No description. |
importFrom | No description. |
interpolationForAttribute | No description. |
moveFromId | Move the resource corresponding to "id" to this resource. |
moveTo | Moves this resource to the target resource given by moveTarget. |
moveToId | Moves this resource to the resource corresponding to "id". |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
Adds this resource to the terraform JSON output.
addMoveTarget
public addMoveTarget(moveTarget: string): void
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
moveTarget
Required
- Type: string
The string move target that will correspond to this resource.
getAnyMapAttribute
public getAnyMapAttribute(terraformAttribute: string): {[ key: string ]: any}
terraformAttribute
Required
- Type: string
getBooleanAttribute
public getBooleanAttribute(terraformAttribute: string): IResolvable
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
public getBooleanMapAttribute(terraformAttribute: string): {[ key: string ]: boolean}
terraformAttribute
Required
- Type: string
getListAttribute
public getListAttribute(terraformAttribute: string): string[]
terraformAttribute
Required
- Type: string
getNumberAttribute
public getNumberAttribute(terraformAttribute: string): number
terraformAttribute
Required
- Type: string
getNumberListAttribute
public getNumberListAttribute(terraformAttribute: string): number[]
terraformAttribute
Required
- Type: string
getNumberMapAttribute
public getNumberMapAttribute(terraformAttribute: string): {[ key: string ]: number}
terraformAttribute
Required
- Type: string
getStringAttribute
public getStringAttribute(terraformAttribute: string): string
terraformAttribute
Required
- Type: string
getStringMapAttribute
public getStringMapAttribute(terraformAttribute: string): {[ key: string ]: string}
terraformAttribute
Required
- Type: string
hasResourceMove
public hasResourceMove(): TerraformResourceMoveByTarget | TerraformResourceMoveById
importFrom
public importFrom(id: string, provider?: TerraformProvider): void
id
Required
- Type: string
provider
Optional
- Type: TerraformProvider
interpolationForAttribute
public interpolationForAttribute(terraformAttribute: string): IResolvable
terraformAttribute
Required
- Type: string
moveFromId
public moveFromId(id: string): void
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
id
Required
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
moveTo
public moveTo(moveTarget: string, index?: string | number): void
Moves this resource to the target resource given by moveTarget.
moveTarget
Required
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
index
Optional
- Type: string | number
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
moveToId
public moveToId(id: string): void
Moves this resource to the resource corresponding to "id".
id
Required
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformResource | No description. |
isConstruct
import { TerraformResource } from 'cdktf'
TerraformResource.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformResource } from 'cdktf'
TerraformResource.isTerraformElement(x: any)
x
Required
- Type: any
isTerraformResource
import { TerraformResource } from 'cdktf'
TerraformResource.isTerraformResource(x: any)
x
Required
- Type: any
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. |
connection | SSHProvisionerConnection | WinrmProvisionerConnection | No description. |
count | number | TerraformCount | No description. |
dependsOn | string[] | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
provisioners | FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[] | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
terraformMetaArguments
Required
public readonly terraformMetaArguments: {[ key: string ]: any};
- Type: {[ key: string ]: any}
terraformResourceType
Required
public readonly terraformResourceType: string;
- Type: string
terraformGeneratorMetadata
Optional
public readonly terraformGeneratorMetadata: TerraformProviderGeneratorMetadata;
connection
Optional
public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
count
Optional
public readonly count: number | TerraformCount;
- Type: number | TerraformCount
dependsOn
Optional
public readonly dependsOn: string[];
- Type: string[]
forEach
Optional
public readonly forEach: ITerraformIterator;
- Type: ITerraformIterator
lifecycle
Optional
public readonly lifecycle: TerraformResourceLifecycle;
provider
Optional
public readonly provider: TerraformProvider;
- Type: TerraformProvider
provisioners
Optional
public readonly provisioners: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[];
- Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]
TerraformStack
Initializers
import { TerraformStack } from 'cdktf'
new TerraformStack(scope: Construct, id: string)
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
Methods
Name | Description |
---|---|
toString | Returns a string representation of this construct. |
addDependency | No description. |
addOverride | No description. |
allProviders | No description. |
dependsOn | No description. |
ensureBackendExists | No description. |
getLogicalId | No description. |
hasResourceMove | No description. |
prepareStack | No description. |
registerIncomingCrossStackReference | No description. |
registerOutgoingCrossStackReference | No description. |
runAllValidations | Run all validations on the stack. |
toHclTerraform | No description. |
toTerraform | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addDependency
public addDependency(dependency: TerraformStack): void
dependency
Required
- Type: TerraformStack
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
allProviders
public allProviders(): TerraformProvider[]
dependsOn
public dependsOn(stack: TerraformStack): boolean
stack
Required
- Type: TerraformStack
ensureBackendExists
public ensureBackendExists(): TerraformBackend
getLogicalId
public getLogicalId(tfElement: Node | TerraformElement): string
tfElement
Required
- Type: constructs.Node | TerraformElement
hasResourceMove
public hasResourceMove(): boolean
prepareStack
public prepareStack(): void
registerIncomingCrossStackReference
public registerIncomingCrossStackReference(fromStack: TerraformStack): TerraformRemoteState
fromStack
Required
- Type: TerraformStack
registerOutgoingCrossStackReference
public registerOutgoingCrossStackReference(identifier: string): TerraformOutput
identifier
Required
- Type: string
runAllValidations
public runAllValidations(): void
Run all validations on the stack.
toHclTerraform
public toHclTerraform(): {[ key: string ]: any}
toTerraform
public toTerraform(): any
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isStack | No description. |
of | No description. |
isConstruct
import { TerraformStack } from 'cdktf'
TerraformStack.isConstruct(x: any)
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: any
Any object.
isStack
import { TerraformStack } from 'cdktf'
TerraformStack.isStack(x: any)
x
Required
- Type: any
of
import { TerraformStack } from 'cdktf'
TerraformStack.of(construct: IConstruct)
construct
Required
- Type: constructs.IConstruct
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
dependencies | TerraformStack[] | No description. |
moveTargets | TerraformResourceTargets | No description. |
synthesizer | IStackSynthesizer | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
dependencies
Required
public readonly dependencies: TerraformStack[];
- Type: TerraformStack[]
moveTargets
Required
public readonly moveTargets: TerraformResourceTargets;
- Type: TerraformResourceTargets
synthesizer
Required
public readonly synthesizer: IStackSynthesizer;
- Type: IStackSynthesizer
TerraformVariable
- Implements: ITerraformAddressable
Initializers
import { TerraformVariable } from 'cdktf'
new TerraformVariable(scope: Construct, id: string, config: TerraformVariableConfig)
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | TerraformVariableConfig | No description. |
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
config
Required
- Type: TerraformVariableConfig
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 | No description. |
toMetadata | No description. |
toTerraform | No description. |
addValidation | No description. |
synthesizeAttributes | No description. |
synthesizeHclAttributes | No description. |
toString
public toString(): string
Returns a string representation of this construct.
addOverride
public addOverride(path: string, value: any): void
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
public overrideLogicalId(newLogicalId: string): void
Overrides the auto-generated logical ID with a specific ID.
newLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
resetOverrideLogicalId
public resetOverrideLogicalId(): void
Resets a previously passed logical Id to use the auto-generated logical id again.
toHclTerraform
public toHclTerraform(): any
toMetadata
public toMetadata(): any
toTerraform
public toTerraform(): any
addValidation
public addValidation(validation: TerraformVariableValidationConfig): void
validation
Required
synthesizeAttributes
public synthesizeAttributes(): {[ key: string ]: any}
synthesizeHclAttributes
public synthesizeHclAttributes(): {[ key: string ]: any}
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
import { TerraformVariable } from 'cdktf'
TerraformVariable.isConstruct(x: any)
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: any
Any object.
isTerraformElement
import { TerraformVariable } from 'cdktf'
TerraformVariable.isTerraformElement(x: any)
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
cdktfStack | TerraformStack | No description. |
fqn | string | No description. |
friendlyUniqueId | string | No description. |
booleanValue | IResolvable | No description. |
listValue | string[] | No description. |
numberValue | number | No description. |
stringValue | string | No description. |
value | any | No description. |
default | any | No description. |
description | string | No description. |
nullable | boolean | No description. |
sensitive | boolean | No description. |
type | string | No description. |
validation | TerraformVariableValidationConfig[] | No description. |
node
Required
public readonly node: Node;
- Type: constructs.Node
The tree node.
cdktfStack
Required
public readonly cdktfStack: TerraformStack;
- Type: TerraformStack
fqn
Required
public readonly fqn: string;
- Type: string
friendlyUniqueId
Required
public readonly friendlyUniqueId: string;
- Type: string
booleanValue
Required
public readonly booleanValue: IResolvable;
- Type: IResolvable
listValue
Required
public readonly listValue: string[];
- Type: string[]
numberValue
Required
public readonly numberValue: number;
- Type: number
stringValue
Required
public readonly stringValue: string;
- Type: string
value
Required
public readonly value: any;
- Type: any
default
Optional
public readonly default: any;
- Type: any
description
Optional
public readonly description: string;
- Type: string
nullable
Optional
public readonly nullable: boolean;
- Type: boolean
sensitive
Optional
public readonly sensitive: boolean;
- Type: boolean
type
Optional
public readonly type: string;
- Type: string
validation
Optional
public readonly validation: TerraformVariableValidationConfig[];