API Reference for Typescript
Constructs
App
Represents a cdktf application.
Initializers
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
Returns a string representation of this construct.
crossStackReference
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
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
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
x
Required
- Type: any
of
construct
Required
- Type: constructs.IConstruct
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
manifest | Manifest | No description. |
outdir | string | The output directory into which resources will be synthesized. |
skipValidation | boolean | Whether to skip the validation during synthesis of the app. |
targetStackId | string | The stack which will be synthesized. |
node
Required
- Type: constructs.Node
The tree node.
manifest
Required
- Type: Manifest
outdir
Required
- Type: string
The output directory into which resources will be synthesized.
skipValidation
Optional
- Type: boolean
Whether to skip the validation during synthesis of the app.
targetStackId
Optional
- Type: string
The stack which will be synthesized.
If not set, all stacks will be synthesized.
ArtifactoryBackend
Initializers
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
props | ArtifactoryBackendConfig | No description. |
scope
Required
- Type: constructs.Construct
props
Required
- Type: ArtifactoryBackendConfig
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. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
toString
toString
Returns a string representation of this construct.
addOverride
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toMetadata
toTerraform
toTerraform
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
getRemoteStateDataSource
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
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
x
Required
- Type: any
isBackend
isBackend
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 artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: constructs.Node
The tree node.
cdktfStack
Required
cdktfStack
- Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: TerraformStack
fqn
Required
fqn
- Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: string
friendlyUniqueId
Required
friendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: string
AzurermBackend
Initializers
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. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
toString
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
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
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
x
Required
- Type: any
isBackend
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- 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
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. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
toString
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
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
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
x
Required
- Type: any
isBackend
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
ConsulBackend
Initializers
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. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
toString
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
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
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
x
Required
- Type: any
isBackend
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
CosBackend
Initializers
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. |
toMetadata | No description. |
toTerraform | Adds this resource to the terraform JSON output. |
getRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
toString
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
getRemoteStateDataSource
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
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
x
Required
- Type: any
isBackend
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
DataTerraformRemoteState
Initializers
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. |
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
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
get
output
Required
- Type: string
getBoolean
output
Required
- Type: string
getList
output
Required
- Type: string
getNumber
output
Required
- Type: string
getString
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
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
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
- Type: string
DataTerraformRemoteStateArtifactory
Initializers
Name | Type | Description |
---|---|---|
scope | constructs.Construct | No description. |
id | string | No description. |
config | DataTerraformRemoteStateArtifactoryConfig | 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. |
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
Returns a string representation of this construct.
addOverride
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toMetadata
toTerraform
toTerraform
Adds this resource to the terraform JSON output.
get
get
output
Required
- Type: string
getBoolean
getBoolean
output
Required
- Type: string
getList
getList
output
Required
- Type: string
getNumber
getNumber
output
Required
- Type: string
getString
getString
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
isConstruct
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
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 artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: constructs.Node
The tree node.
cdktfStack
Required
cdktfStack
- Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: TerraformStack
fqn
Required
fqn
- Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: string
friendlyUniqueId
Required
friendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
tfResourceType
- Deprecated: CDK for Terraform no longer supports the artifactory backend. Terraform deprecated artifactory in v1.2.3 and removed it in v1.3.
- Type: string
DataTerraformRemoteStateAzurerm
Initializers
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. |
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
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
get
output
Required
- Type: string
getBoolean
output
Required
- Type: string
getList
output
Required
- Type: string
getNumber
output
Required
- Type: string
getString
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
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
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
- Type: string
DataTerraformRemoteStateConsul
Initializers
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. |
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
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
get
output
Required
- Type: string
getBoolean
output
Required
- Type: string
getList
output
Required
- Type: string
getNumber
output
Required
- Type: string
getString
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
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
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
Constants
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
- Type: string
DataTerraformRemoteStateCos
Initializers
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. |
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
Returns a string representation of this construct.
addOverride
path
Required
- Type: string
value
Required
- Type: any
overrideLogicalId
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
Resets a previously passed logical Id to use the auto-generated logical id again.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
get
output
Required
- Type: string
getBoolean
output
Required
- Type: string
getList
output
Required
- Type: string
getNumber
output
Required
- Type: string
getString
output
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isConstruct
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