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. |
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
- Type: constructs.Node
The tree node.
hclOutput
Required
- Type: boolean
manifest
Required
- Type: Manifest
outdir
Required
- Type: string
The output directory into which resources will be synthesized.
skipBackendValidation
Required
- Type: boolean
Whether to skip backend validation during synthesis of the app.
skipValidation
Required
- Type: boolean
Whether to skip all validations during synthesis of the app.
targetStackId
Optional
- Type: string
The stack which will be synthesized.
If not set, all stacks will be synthesized.
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. |
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
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.
toHclTerraform
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. |
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
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.
toHclTerraform
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. |
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
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.
toHclTerraform
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. |
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
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.
toHclTerraform
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
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
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
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.
toHclTerraform
toMetadata
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.
moveTarget
Required
- Type: string
The string move target that will correspond to this resource.
getAnyMapAttribute
terraformAttribute
Required
- Type: string
getBooleanAttribute
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
terraformAttribute
Required
- Type: string
getListAttribute
terraformAttribute
Required
- Type: string
getNumberAttribute
terraformAttribute
Required
- Type: string
getNumberListAttribute
terraformAttribute
Required
- Type: string
getNumberMapAttribute
terraformAttribute
Required
- Type: string
getStringAttribute
terraformAttribute
Required
- Type: string
getStringMapAttribute
terraformAttribute
Required
- Type: string
hasResourceMove
importFrom
id
Required
- Type: string
provider
Optional
- Type: TerraformProvider
interpolationForAttribute
terraformAttribute
Required
- Type: string
moveFromId
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
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
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
resetTriggersReplace
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
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
isTerraformResource
x
Required
- Type: any
generateConfigForImport
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
terraformMetaArguments
Required
- Type: {[ key: string ]: any}
terraformResourceType
Required
- Type: string
terraformGeneratorMetadata
Optional
connection
Optional
count
Optional
- Type: number | TerraformCount
dependsOn
Optional
- Type: string[]
forEach
Optional
- Type: ITerraformIterator
lifecycle
Optional
provider
Optional
- Type: TerraformProvider
provisioners
Optional
- Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]
id
Required
- Type: string
output
Required
- Type: AnyMap
inputInput
Optional
- Type: {[ key: string ]: any}
triggersReplaceInput
Optional
- Type: {[ key: string ]: any}
input
Required
- 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
- 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
- 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. |
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
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. |
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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. |
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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. |
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
DataTerraformRemoteStateGcs
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
DataTerraformRemoteStateHttp
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
DataTerraformRemoteStateLocal
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
DataTerraformRemoteStateOss
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
DataTerraformRemoteStatePg
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
DataTerraformRemoteStateS3
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
DataTerraformRemoteStateSwift
Initializers
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
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.
toHclTerraform
toHclTerraform
Adds this resource to the terraform JSON output.
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 swift backend. Terraform deprecated swift 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 swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- 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.
- 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.
- 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.
- Type: string
GcsBackend
Initializers
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
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.
toHclTerraform
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
HttpBackend
Initializers
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
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.
toHclTerraform
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
ImportableResource
Class used to represent an importable resource.
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
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
LocalBackend
Initializers
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
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.
toHclTerraform
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
OssBackend
Initializers
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
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.
toHclTerraform
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
PgBackend
Initializers
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
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.
toHclTerraform
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
RemoteBackend
Initializers
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
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.
toHclTerraform
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
Resource
- Implements: IResource
A construct which represents a resource.
Initializers
scope
Required
- Type: constructs.Construct
id
Required
- Type: string
Methods
Name | Description |
---|---|
toString | Returns a string representation of this construct. |
toString
toString
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
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.
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.
- Type: constructs.Node
The tree node.
stack
Required
stack
- Deprecated: - Please use Construct from the constructs package instead.
- Type: TerraformStack
The stack in which this resource is defined.
S3Backend
Initializers
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
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.
toHclTerraform
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
SwiftBackend
Initializers
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
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.
toHclTerraform
toHclTerraform
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 swift backend. Terraform deprecated swift 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 swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- 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.
- 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.
- Type: string
TerraformAsset
Initializers
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
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
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.
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
- Type: constructs.Node
The tree node.
fileName
Required
- Type: string
Name of the asset.
path
Required
- Type: string
The path relative to the root of the terraform directory in posix format Use this property to reference the asset.
assetHash
Required
- Type: string
type
Required
- Type: AssetType
TerraformBackend
Initializers
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
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.
toHclTerraform
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
TerraformDataSource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
toMetadata
toTerraform
Adds this resource to the terraform JSON output.
getAnyMapAttribute
terraformAttribute
Required
- Type: string
getBooleanAttribute
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
terraformAttribute
Required
- Type: string
getListAttribute
terraformAttribute
Required
- Type: string
getNumberAttribute
terraformAttribute
Required
- Type: string
getNumberListAttribute
terraformAttribute
Required
- Type: string
getNumberMapAttribute
terraformAttribute
Required
- Type: string
getStringAttribute
terraformAttribute
Required
- Type: string
getStringMapAttribute
terraformAttribute
Required
- Type: string
interpolationForAttribute
terraformAttribute
Required
- Type: string
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformDataSource | 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
isTerraformDataSource
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
terraformMetaArguments
Required
- Type: {[ key: string ]: any}
terraformResourceType
Required
- Type: string
terraformGeneratorMetadata
Optional
count
Optional
- Type: number | TerraformCount
dependsOn
Optional
- Type: string[]
forEach
Optional
- Type: ITerraformIterator
lifecycle
Optional
provider
Optional
- Type: TerraformProvider
TerraformElement
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
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
TerraformHclModule
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
addProvider
provider
Required
getString
output
Required
- Type: string
interpolationForOutput
moduleOutput
Required
- Type: string
get
output
Required
- Type: string
getBoolean
output
Required
- Type: string
getList
output
Required
- Type: string
getNumber
output
Required
- Type: string
set
variable
Required
- Type: string
value
Required
- Type: any
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. |
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
source
Required
- Type: string
providers
Optional
- Type: TerraformProvider | TerraformModuleProvider[]
skipAssetCreationFromLocalModules
Optional
- Type: boolean
version
Optional
- Type: string
dependsOn
Optional
- Type: string[]
forEach
Optional
- Type: ITerraformIterator
variables
Optional
- Type: {[ key: string ]: any}
TerraformLocal
- Implements: ITerraformAddressable
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
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. |
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
asAnyMap
Required
- Type: {[ key: string ]: any}
asBoolean
Required
- Type: IResolvable
asBooleanMap
Required
- Type: {[ key: string ]: boolean}
asList
Required
- Type: string[]
asNumber
Required
- Type: number
asNumberMap
Required
- Type: {[ key: string ]: number}
asString
Required
- Type: string
asStringMap
Required
- Type: {[ key: string ]: string}
expression
Required
- Type: any
TerraformModule
- Implements: ITerraformDependable
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
addProvider
provider
Required
getString
output
Required
- Type: string
interpolationForOutput
moduleOutput
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. |
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
source
Required
- Type: string
providers
Optional
- Type: TerraformProvider | TerraformModuleProvider[]
skipAssetCreationFromLocalModules
Optional
- Type: boolean
version
Optional
- Type: string
dependsOn
Optional
- Type: string[]
forEach
Optional
- Type: ITerraformIterator
TerraformOutput
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isTerraformElement | No description. |
isTerraformOutput | 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
isTerraformOutput
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
staticId
Required
- Type: boolean
value
Required
- Type: any
dependsOn
Optional
- Type: ITerraformDependable[]
description
Optional
- Type: string
precondition
Optional
- Type: Precondition
sensitive
Optional
- Type: boolean
TerraformProvider
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
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
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
isTerraformProvider
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
metaAttributes
Required
- Type: {[ key: string ]: any}
terraformResourceType
Required
- Type: string
terraformGeneratorMetadata
Optional
terraformProviderSource
Optional
- Type: string
alias
Optional
- Type: string
TerraformRemoteState
- Implements: ITerraformAddressable
Initializers
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
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.
toHclTerraform
Adds this resource to the terraform JSON output.
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
TerraformResource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
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
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.
toHclTerraform
toMetadata
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.
moveTarget
Required
- Type: string
The string move target that will correspond to this resource.
getAnyMapAttribute
terraformAttribute
Required
- Type: string
getBooleanAttribute
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
terraformAttribute
Required
- Type: string
getListAttribute
terraformAttribute
Required
- Type: string
getNumberAttribute
terraformAttribute
Required
- Type: string
getNumberListAttribute
terraformAttribute
Required
- Type: string
getNumberMapAttribute
terraformAttribute
Required
- Type: string
getStringAttribute
terraformAttribute
Required
- Type: string
getStringMapAttribute
terraformAttribute
Required
- Type: string
hasResourceMove
importFrom
id
Required
- Type: string
provider
Optional
- Type: TerraformProvider
interpolationForAttribute
terraformAttribute
Required
- Type: string
moveFromId
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
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
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
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
isTerraformResource
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
terraformMetaArguments
Required
- Type: {[ key: string ]: any}
terraformResourceType
Required
- Type: string
terraformGeneratorMetadata
Optional
connection
Optional
count
Optional
- Type: number | TerraformCount
dependsOn
Optional
- Type: string[]
forEach
Optional
- Type: ITerraformIterator
lifecycle
Optional
provider
Optional
- Type: TerraformProvider
provisioners
Optional
- Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]
TerraformStack
Initializers
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
Returns a string representation of this construct.
addDependency
dependency
Required
- Type: TerraformStack
addOverride
path
Required
- Type: string
value
Required
- Type: any
allProviders
dependsOn
stack
Required
- Type: TerraformStack
ensureBackendExists
getLogicalId
tfElement
Required
- Type: constructs.Node | TerraformElement
hasResourceMove
prepareStack
registerIncomingCrossStackReference
fromStack
Required
- Type: TerraformStack
registerOutgoingCrossStackReference
identifier
Required
- Type: string
runAllValidations
Run all validations on the stack.
toHclTerraform
toTerraform
Static Functions
Name | Description |
---|---|
isConstruct | Checks if x is a construct. |
isStack | 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.
isStack
x
Required
- Type: any
of
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
- Type: constructs.Node
The tree node.
dependencies
Required
- Type: TerraformStack[]
moveTargets
Required
- Type: TerraformResourceTargets
synthesizer
Required
- Type: IStackSynthesizer
TerraformVariable
- Implements: ITerraformAddressable
Initializers
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
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.
toHclTerraform
toMetadata
toTerraform
addValidation
validation
Required
synthesizeAttributes
synthesizeHclAttributes
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. |
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
- Type: constructs.Node
The tree node.
cdktfStack
Required
- Type: TerraformStack
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
booleanValue
Required
- Type: IResolvable
listValue
Required
- Type: string[]
numberValue
Required
- Type: number
stringValue
Required
- Type: string
value
Required
- Type: any
default
Optional
- Type: any
description
Optional
- Type: string
nullable
Optional
- Type: boolean
sensitive
Optional
- Type: boolean
type
Optional
- Type: string
validation
Optional
Structs
AppConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
context | {[ key: string ]: any} | Additional context values for the application. |
hclOutput | boolean | No description. |
outdir | string | The directory to output Terraform resources. |
skipBackendValidation | boolean | Whether to skip backend validation during synthesis of the app. |
skipValidation | boolean | Whether to skip all validations during synthesis of the app. |
stackTraces | boolean | No description. |
context
Optional
- Type: {[ key: string ]: any}
- Default: no additional context
Additional context values for the application.
Context set by the CLI or the context
key in cdktf.json
has precedence.
Context can be read from any construct using node.getContext(key)
.
hclOutput
Optional
- Type: boolean
outdir
Optional
- Type: string
- Default: CDKTF_OUTDIR if defined, otherwise "cdktf.out"
The directory to output Terraform resources.
If you are using the CDKTF CLI, this value is automatically set from one of the following three sources:
- The
-o
/--output
CLI option - The
CDKTF_OUTDIR
environment variable - The
outdir
key incdktf.json
If you are using the CDKTF CLI and want to set a different value here, you will also need to set the same value via one of the three ways specified above.
The most common case to set this value is when you are using the CDKTF library directly (e.g. when writing unit tests).
skipBackendValidation
Optional
- Type: boolean
- Default: false
Whether to skip backend validation during synthesis of the app.
skipValidation
Optional
- Type: boolean
- Default: false
Whether to skip all validations during synthesis of the app.
stackTraces
Optional
- Type: boolean
AzurermBackendConfig
Stores the state as a Blob with the given Key within the Blob Container within the Blob Storage Account.
This backend supports state locking and consistency checking with Azure Blob Storage native capabilities.
Note: By default the Azure Backend uses ADAL for authentication which is deprecated in favour of MSAL - MSAL can be used by setting use_microsoft_graph to true. The default for this will change in Terraform 1.2, so that MSAL authentication is used by default.
Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/azurerm
Initializer
Properties
Name | Type | Description |
---|---|---|
containerName | string | (Required) The Name of the Storage Container within the Storage Account. |
key | string | (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container. |
storageAccountName | string | (Required) The Name of the Storage Account. |
accessKey | string | access_key - (Optional) The Access Key used to access the Blob Storage Account. |
clientCertificatePassword | string | (Optional) The password associated with the Client Certificate specified in client_certificate_path. |
clientCertificatePath | string | (Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal. |
clientId | string | (Optional) The Client ID of the Service Principal. |
clientSecret | string | (Optional) The Client Secret of the Service Principal. |
endpoint | string | (Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable. |
environment | string | (Optional) The Azure Environment which should be used. |
metadataHost | string | (Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.). |
msiEndpoint | string | (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. |
oidcRequestToken | string | (Optional) The bearer token for the request to the OIDC provider. |
oidcRequestUrl | string | (Optional) The URL for the OIDC provider from which to request an ID token. |
oidcToken | string | (Optional) The ID token when authenticating using OpenID Connect (OIDC). |
oidcTokenFilePath | string | (Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC). |
resourceGroupName | string | (Required) The Name of the Resource Group in which the Storage Account exists. |
sasToken | string | (Optional) The SAS Token used to access the Blob Storage Account. |
snapshot | boolean | (Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use? |
subscriptionId | string | (Optional) The Subscription ID in which the Storage Account exists. |
tenantId | string | (Optional) The Tenant ID in which the Subscription exists. |
useAzureadAuth | boolean | (Optional) Should AzureAD Authentication be used to access the Blob Storage Account. |
useMicrosoftGraph | boolean | (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? |
useMsi | boolean | (Optional) Should Managed Service Identity authentication be used? |
useOidc | boolean | (Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable. |
containerName
Required
- Type: string
(Required) The Name of the Storage Container within the Storage Account.
key
Required
- Type: string
(Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.
storageAccountName
Required
- Type: string
(Required) The Name of the Storage Account.
accessKey
Optional
- Type: string
access_key - (Optional) The Access Key used to access the Blob Storage Account.
This can also be sourced from the ARM_ACCESS_KEY environment variable.
clientCertificatePassword
Optional
- Type: string
(Optional) The password associated with the Client Certificate specified in client_certificate_path.
This can also be sourced from the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable.
clientCertificatePath
Optional
- Type: string
(Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.
This can also be sourced from the ARM_CLIENT_CERTIFICATE_PATH environment variable.
clientId
Optional
- Type: string
(Optional) The Client ID of the Service Principal.
This can also be sourced from the ARM_CLIENT_ID environment variable.
clientSecret
Optional
- Type: string
(Optional) The Client Secret of the Service Principal.
This can also be sourced from the ARM_CLIENT_SECRET environment variable.
endpoint
Optional
- Type: string
(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.
NOTE: An endpoint should only be configured when using Azure Stack.
environment
Optional
- Type: string
(Optional) The Azure Environment which should be used.
This can also be sourced from the ARM_ENVIRONMENT environment variable. Possible values are public, china, german, stack and usgovernment. Defaults to public.
metadataHost
Optional
- Type: string
(Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.).
msiEndpoint
Optional
- Type: string
(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.
This can also be sourced from the ARM_MSI_ENDPOINT environment variable.
oidcRequestToken
Optional
- Type: string
(Optional) The bearer token for the request to the OIDC provider.
This can also be sourced from the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables.
oidcRequestUrl
Optional
- Type: string
(Optional) The URL for the OIDC provider from which to request an ID token.
This can also be sourced from the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables.
oidcToken
Optional
- Type: string
(Optional) The ID token when authenticating using OpenID Connect (OIDC).
This can also be sourced from the ARM_OIDC_TOKEN environment variable.
oidcTokenFilePath
Optional
- Type: string
(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC).
This can also be sourced from the ARM_OIDC_TOKEN_FILE_PATH environment variable.
resourceGroupName
Optional
- Type: string
(Required) The Name of the Resource Group in which the Storage Account exists.
sasToken
Optional
- Type: string
(Optional) The SAS Token used to access the Blob Storage Account.
This can also be sourced from the ARM_SAS_TOKEN environment variable.
snapshot
Optional
- Type: boolean
(Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?
Defaults to false. This value can also be sourced from the ARM_SNAPSHOT environment variable.
subscriptionId
Optional
- Type: string
(Optional) The Subscription ID in which the Storage Account exists.
This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
tenantId
Optional
- Type: string
(Optional) The Tenant ID in which the Subscription exists.
This can also be sourced from the ARM_TENANT_ID environment variable.
useAzureadAuth
Optional
- Type: boolean
(Optional) Should AzureAD Authentication be used to access the Blob Storage Account.
This can also be sourced from the ARM_USE_AZUREAD environment variable.
Note: When using AzureAD for Authentication to Storage you also need to ensure the Storage Blob Data Owner role is assigned.
useMicrosoftGraph
Optional
- Type: boolean
(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?
Defaults to true.
Note: In Terraform 1.2 the Azure Backend uses MSAL (and Microsoft Graph) rather than ADAL (and Azure Active Directory Graph) for authentication by default - you can disable this by setting use_microsoft_graph to false. This setting will be removed in Terraform 1.3, due to Microsoft's deprecation of ADAL.
useMsi
Optional
- Type: boolean
(Optional) Should Managed Service Identity authentication be used?
This can also be sourced from the ARM_USE_MSI environment variable.
useOidc
Optional
- Type: boolean
(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.
Note: When using OIDC for authentication, use_microsoft_graph must be set to true (which is the default).
CloudBackendConfig
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.
https://developer.hashicorp.com/terraform/cli/cloud/settings#arguments
Initializer
Properties
Name | Type | Description |
---|---|---|
organization | string | The name of the organization containing the workspace(s) the current configuration should use. |
workspaces | NamedCloudWorkspace | TaggedCloudWorkspaces | A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration. |
hostname | string | The hostname of a Terraform Enterprise installation, if using Terraform Enterprise. |
token | string | The token used to authenticate with Terraform Cloud. |
organization
Required
- Type: string
The name of the organization containing the workspace(s) the current configuration should use.
workspaces
Required
A nested block that specifies which remote Terraform Cloud workspaces to use for the current configuration.
The workspaces block must contain exactly one of the following arguments, each denoting a strategy for how workspaces should be mapped:
hostname
Optional
- Type: string
- Default: app.terraform.io
The hostname of a Terraform Enterprise installation, if using Terraform Enterprise.
token
Optional
- Type: string
The token used to authenticate with Terraform Cloud.
We recommend omitting the token from the configuration, and instead using terraform login or manually configuring credentials in the CLI config file.
ConsulBackendConfig
Stores the state in the Consul KV store at a given path. This backend supports state locking.
Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/consul
Initializer
Properties
Name | Type | Description |
---|---|---|
accessToken | string | (Required) Access token. |
path | string | (Required) Path in the Consul KV store. |
address | string | (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. |
caFile | string | (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. |
certFile | string | (Optional) A path to a PEM-encoded certificate provided to the remote agent; |
datacenter | string | (Optional) The datacenter to use. |
gzip | boolean | (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed. |
httpAuth | string | (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. |
keyFile | string | (Optional) A path to a PEM-encoded private key, required if cert_file is specified. |
lock | boolean | (Optional) false to disable locking. |
scheme | string | (Optional) Specifies what protocol to use when talking to the given address,either http or https. |
accessToken
Required
- Type: string
(Required) Access token.
path
Required
- Type: string
(Required) Path in the Consul KV store.
address
Optional
- Type: string
(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
Defaults to the local agent HTTP listener.
caFile
Optional
- Type: string
(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
certFile
Optional
- Type: string
(Optional) A path to a PEM-encoded certificate provided to the remote agent;
requires use of key_file.
datacenter
Optional
- Type: string
(Optional) The datacenter to use.
Defaults to that of the agent.
gzip
Optional
- Type: boolean
(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
httpAuth
Optional
- Type: string
(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
keyFile
Optional
- Type: string
(Optional) A path to a PEM-encoded private key, required if cert_file is specified.
lock
Optional
- Type: boolean
(Optional) false to disable locking.
This defaults to true, but will require session permissions with Consul and at least kv write permissions on $path/.lock to perform locking.
scheme
Optional
- Type: string
(Optional) Specifies what protocol to use when talking to the given address,either http or https.
SSL support can also be triggered by setting then environment variable CONSUL_HTTP_SSL to true.
CosBackendAssumeRole
Initializer
Properties
Name | Type | Description |
---|---|---|
roleArn | string | (Required) The ARN of the role to assume. |
sessionDuration | number | (Required) The duration of the session when making the AssumeRole call. |
sessionName | string | (Required) The session name to use when making the AssumeRole call. |
policy | any | (Optional) A more restrictive policy when making the AssumeRole call. |
roleArn
Required
- Type: string
(Required) The ARN of the role to assume.
It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_ARN.
sessionDuration
Required
- Type: number
(Required) The duration of the session when making the AssumeRole call.
Its value ranges from 0 to 43200(seconds), and default is 7200 seconds. It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_SESSION_DURATION.
sessionName
Required
- Type: string
(Required) The session name to use when making the AssumeRole call.
It can be sourced from the TENCENTCLOUD_ASSUME_ROLE_SESSION_NAME.
policy
Optional
- Type: any
(Optional) A more restrictive policy when making the AssumeRole call.
Its content must not contains principal elements. Please refer to {@link https://www.tencentcloud.com/document/product/598/10603 policies syntax logic}.
CosBackendConfig
Stores the state as an object in a configurable prefix in a given bucket on Tencent Cloud Object Storage (COS).
This backend supports state locking.
Warning! It is highly recommended that you enable Object Versioning on the COS bucket to allow for state recovery in the case of accidental deletions and human error.
Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/cos
Initializer
Properties
Name | Type | Description |
---|---|---|
bucket | string | (Required) The name of the COS bucket. |
accelerate | boolean | (Optional) Whether to enable global Acceleration. |
acl | string | (Optional) Object ACL to be applied to the state file, allows private and public-read. |
assumeRole | CosBackendAssumeRole | (Optional) The assume_role block. |
domain | string | (Optional) The root domain of the API request. |
encrypt | boolean | (Optional) Whether to enable server side encryption of the state file. |
endpoint | string | (Optional) The Custom Endpoint for the COS backend. |
key | string | (Optional) The path for saving the state file in bucket. |
prefix | string | (Optional) The directory for saving the state file in bucket. |
region | string | (Optional) The region of the COS bucket. |
secretId | string | (Optional) Secret id of Tencent Cloud. |
secretKey | string | (Optional) Secret key of Tencent Cloud. |
securityToken | string | (Optional) TencentCloud Security Token of temporary access credentials. |
bucket
Required
- Type: string
(Required) The name of the COS bucket.
You shall manually create it first.
accelerate
Optional
- Type: boolean
(Optional) Whether to enable global Acceleration.
Defaults to false.
acl
Optional
- Type: string
(Optional) Object ACL to be applied to the state file, allows private and public-read.
Defaults to private.
assumeRole
Optional
- Type: CosBackendAssumeRole
(Optional) The assume_role block.
If provided, terraform will attempt to assume this role using the supplied credentials.
domain
Optional
- Type: string
(Optional) The root domain of the API request.
Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.
encrypt
Optional
- Type: boolean
(Optional) Whether to enable server side encryption of the state file.
If it is true, COS will use 'AES256' encryption algorithm to encrypt state file.
endpoint
Optional
- Type: string
(Optional) The Custom Endpoint for the COS backend.
It supports the environment variable TENCENTCLOUD_ENDPOINT.
key
Optional
- Type: string
(Optional) The path for saving the state file in bucket.
Defaults to terraform.tfstate.
prefix
Optional
- Type: string
(Optional) The directory for saving the state file in bucket.
Default to "env:".
region
Optional
- Type: string
(Optional) The region of the COS bucket.
It supports environment variables TENCENTCLOUD_REGION.
secretId
Optional
- Type: string
(Optional) Secret id of Tencent Cloud.
It supports environment variables TENCENTCLOUD_SECRET_ID.
secretKey
Optional
- Type: string
(Optional) Secret key of Tencent Cloud.
It supports environment variables TENCENTCLOUD_SECRET_KEY.
securityToken
Optional
- Type: string
(Optional) TencentCloud Security Token of temporary access credentials.
It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.
DataConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
connection | SSHProvisionerConnection | WinrmProvisionerConnection | No description. |
count | number | TerraformCount | No description. |
dependsOn | ITerraformDependable[] | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
provisioners | FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[] | 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. |
connection
Optional
count
Optional
- Type: number | TerraformCount
dependsOn
Optional
- Type: ITerraformDependable[]
forEach
Optional
- Type: ITerraformIterator
lifecycle
Optional
provider
Optional
- Type: TerraformProvider
provisioners
Optional
- Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]
input
Optional
- 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
Optional
- 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
DataTerraformRemoteStateAzurermConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
containerName | string | (Required) The Name of the Storage Container within the Storage Account. |
key | string | (Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container. |
storageAccountName | string | (Required) The Name of the Storage Account. |
accessKey | string | access_key - (Optional) The Access Key used to access the Blob Storage Account. |
clientCertificatePassword | string | (Optional) The password associated with the Client Certificate specified in client_certificate_path. |
clientCertificatePath | string | (Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal. |
clientId | string | (Optional) The Client ID of the Service Principal. |
clientSecret | string | (Optional) The Client Secret of the Service Principal. |
endpoint | string | (Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable. |
environment | string | (Optional) The Azure Environment which should be used. |
metadataHost | string | (Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.). |
msiEndpoint | string | (Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified. |
oidcRequestToken | string | (Optional) The bearer token for the request to the OIDC provider. |
oidcRequestUrl | string | (Optional) The URL for the OIDC provider from which to request an ID token. |
oidcToken | string | (Optional) The ID token when authenticating using OpenID Connect (OIDC). |
oidcTokenFilePath | string | (Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC). |
resourceGroupName | string | (Required) The Name of the Resource Group in which the Storage Account exists. |
sasToken | string | (Optional) The SAS Token used to access the Blob Storage Account. |
snapshot | boolean | (Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use? |
subscriptionId | string | (Optional) The Subscription ID in which the Storage Account exists. |
tenantId | string | (Optional) The Tenant ID in which the Subscription exists. |
useAzureadAuth | boolean | (Optional) Should AzureAD Authentication be used to access the Blob Storage Account. |
useMicrosoftGraph | boolean | (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? |
useMsi | boolean | (Optional) Should Managed Service Identity authentication be used? |
useOidc | boolean | (Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
containerName
Required
- Type: string
(Required) The Name of the Storage Container within the Storage Account.
key
Required
- Type: string
(Required) The name of the Blob used to retrieve/store Terraform's State file inside the Storage Container.
storageAccountName
Required
- Type: string
(Required) The Name of the Storage Account.
accessKey
Optional
- Type: string
access_key - (Optional) The Access Key used to access the Blob Storage Account.
This can also be sourced from the ARM_ACCESS_KEY environment variable.
clientCertificatePassword
Optional
- Type: string
(Optional) The password associated with the Client Certificate specified in client_certificate_path.
This can also be sourced from the ARM_CLIENT_CERTIFICATE_PASSWORD environment variable.
clientCertificatePath
Optional
- Type: string
(Optional) The path to the PFX file used as the Client Certificate when authenticating as a Service Principal.
This can also be sourced from the ARM_CLIENT_CERTIFICATE_PATH environment variable.
clientId
Optional
- Type: string
(Optional) The Client ID of the Service Principal.
This can also be sourced from the ARM_CLIENT_ID environment variable.
clientSecret
Optional
- Type: string
(Optional) The Client Secret of the Service Principal.
This can also be sourced from the ARM_CLIENT_SECRET environment variable.
endpoint
Optional
- Type: string
(Optional) The Custom Endpoint for Azure Resource Manager. This can also be sourced from the ARM_ENDPOINT environment variable.
NOTE: An endpoint should only be configured when using Azure Stack.
environment
Optional
- Type: string
(Optional) The Azure Environment which should be used.
This can also be sourced from the ARM_ENVIRONMENT environment variable. Possible values are public, china, german, stack and usgovernment. Defaults to public.
metadataHost
Optional
- Type: string
(Optional) The Hostname of the Azure Metadata Service (for example management.azure.com), used to obtain the Cloud Environment when using a Custom Azure Environment. This can also be sourced from the ARM_METADATA_HOSTNAME Environment Variable.).
msiEndpoint
Optional
- Type: string
(Optional) The path to a custom Managed Service Identity endpoint which is automatically determined if not specified.
This can also be sourced from the ARM_MSI_ENDPOINT environment variable.
oidcRequestToken
Optional
- Type: string
(Optional) The bearer token for the request to the OIDC provider.
This can also be sourced from the ARM_OIDC_REQUEST_TOKEN or ACTIONS_ID_TOKEN_REQUEST_TOKEN environment variables.
oidcRequestUrl
Optional
- Type: string
(Optional) The URL for the OIDC provider from which to request an ID token.
This can also be sourced from the ARM_OIDC_REQUEST_URL or ACTIONS_ID_TOKEN_REQUEST_URL environment variables.
oidcToken
Optional
- Type: string
(Optional) The ID token when authenticating using OpenID Connect (OIDC).
This can also be sourced from the ARM_OIDC_TOKEN environment variable.
oidcTokenFilePath
Optional
- Type: string
(Optional) The path to a file containing an ID token when authenticating using OpenID Connect (OIDC).
This can also be sourced from the ARM_OIDC_TOKEN_FILE_PATH environment variable.
resourceGroupName
Optional
- Type: string
(Required) The Name of the Resource Group in which the Storage Account exists.
sasToken
Optional
- Type: string
(Optional) The SAS Token used to access the Blob Storage Account.
This can also be sourced from the ARM_SAS_TOKEN environment variable.
snapshot
Optional
- Type: boolean
(Optional) Should the Blob used to store the Terraform Statefile be snapshotted before use?
Defaults to false. This value can also be sourced from the ARM_SNAPSHOT environment variable.
subscriptionId
Optional
- Type: string
(Optional) The Subscription ID in which the Storage Account exists.
This can also be sourced from the ARM_SUBSCRIPTION_ID environment variable.
tenantId
Optional
- Type: string
(Optional) The Tenant ID in which the Subscription exists.
This can also be sourced from the ARM_TENANT_ID environment variable.
useAzureadAuth
Optional
- Type: boolean
(Optional) Should AzureAD Authentication be used to access the Blob Storage Account.
This can also be sourced from the ARM_USE_AZUREAD environment variable.
Note: When using AzureAD for Authentication to Storage you also need to ensure the Storage Blob Data Owner role is assigned.
useMicrosoftGraph
Optional
- Type: boolean
(Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph?
Defaults to true.
Note: In Terraform 1.2 the Azure Backend uses MSAL (and Microsoft Graph) rather than ADAL (and Azure Active Directory Graph) for authentication by default - you can disable this by setting use_microsoft_graph to false. This setting will be removed in Terraform 1.3, due to Microsoft's deprecation of ADAL.
useMsi
Optional
- Type: boolean
(Optional) Should Managed Service Identity authentication be used?
This can also be sourced from the ARM_USE_MSI environment variable.
useOidc
Optional
- Type: boolean
(Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable.
Note: When using OIDC for authentication, use_microsoft_graph must be set to true (which is the default).
DataTerraformRemoteStateConfig
Initializer
Properties
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
DataTerraformRemoteStateConsulConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
accessToken | string | (Required) Access token. |
path | string | (Required) Path in the Consul KV store. |
address | string | (Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port. |
caFile | string | (Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate. |
certFile | string | (Optional) A path to a PEM-encoded certificate provided to the remote agent; |
datacenter | string | (Optional) The datacenter to use. |
gzip | boolean | (Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed. |
httpAuth | string | (Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass. |
keyFile | string | (Optional) A path to a PEM-encoded private key, required if cert_file is specified. |
lock | boolean | (Optional) false to disable locking. |
scheme | string | (Optional) Specifies what protocol to use when talking to the given address,either http or https. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
accessToken
Required
- Type: string
(Required) Access token.
path
Required
- Type: string
(Required) Path in the Consul KV store.
address
Optional
- Type: string
(Optional) DNS name and port of your Consul endpoint specified in the format dnsname:port.
Defaults to the local agent HTTP listener.
caFile
Optional
- Type: string
(Optional) A path to a PEM-encoded certificate authority used to verify the remote agent's certificate.
certFile
Optional
- Type: string
(Optional) A path to a PEM-encoded certificate provided to the remote agent;
requires use of key_file.
datacenter
Optional
- Type: string
(Optional) The datacenter to use.
Defaults to that of the agent.
gzip
Optional
- Type: boolean
(Optional) true to compress the state data using gzip, or false (the default) to leave it uncompressed.
httpAuth
Optional
- Type: string
(Optional) HTTP Basic Authentication credentials to be used when communicating with Consul, in the format of either user or user:pass.
keyFile
Optional
- Type: string
(Optional) A path to a PEM-encoded private key, required if cert_file is specified.
lock
Optional
- Type: boolean
(Optional) false to disable locking.
This defaults to true, but will require session permissions with Consul and at least kv write permissions on $path/.lock to perform locking.
scheme
Optional
- Type: string
(Optional) Specifies what protocol to use when talking to the given address,either http or https.
SSL support can also be triggered by setting then environment variable CONSUL_HTTP_SSL to true.
DataTerraformRemoteStateCosConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
bucket | string | (Required) The name of the COS bucket. |
accelerate | boolean | (Optional) Whether to enable global Acceleration. |
acl | string | (Optional) Object ACL to be applied to the state file, allows private and public-read. |
assumeRole | CosBackendAssumeRole | (Optional) The assume_role block. |
domain | string | (Optional) The root domain of the API request. |
encrypt | boolean | (Optional) Whether to enable server side encryption of the state file. |
endpoint | string | (Optional) The Custom Endpoint for the COS backend. |
key | string | (Optional) The path for saving the state file in bucket. |
prefix | string | (Optional) The directory for saving the state file in bucket. |
region | string | (Optional) The region of the COS bucket. |
secretId | string | (Optional) Secret id of Tencent Cloud. |
secretKey | string | (Optional) Secret key of Tencent Cloud. |
securityToken | string | (Optional) TencentCloud Security Token of temporary access credentials. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
bucket
Required
- Type: string
(Required) The name of the COS bucket.
You shall manually create it first.
accelerate
Optional
- Type: boolean
(Optional) Whether to enable global Acceleration.
Defaults to false.
acl
Optional
- Type: string
(Optional) Object ACL to be applied to the state file, allows private and public-read.
Defaults to private.
assumeRole
Optional
- Type: CosBackendAssumeRole
(Optional) The assume_role block.
If provided, terraform will attempt to assume this role using the supplied credentials.
domain
Optional
- Type: string
(Optional) The root domain of the API request.
Defaults to tencentcloudapi.com. It supports the environment variable TENCENTCLOUD_DOMAIN.
encrypt
Optional
- Type: boolean
(Optional) Whether to enable server side encryption of the state file.
If it is true, COS will use 'AES256' encryption algorithm to encrypt state file.
endpoint
Optional
- Type: string
(Optional) The Custom Endpoint for the COS backend.
It supports the environment variable TENCENTCLOUD_ENDPOINT.
key
Optional
- Type: string
(Optional) The path for saving the state file in bucket.
Defaults to terraform.tfstate.
prefix
Optional
- Type: string
(Optional) The directory for saving the state file in bucket.
Default to "env:".
region
Optional
- Type: string
(Optional) The region of the COS bucket.
It supports environment variables TENCENTCLOUD_REGION.
secretId
Optional
- Type: string
(Optional) Secret id of Tencent Cloud.
It supports environment variables TENCENTCLOUD_SECRET_ID.
secretKey
Optional
- Type: string
(Optional) Secret key of Tencent Cloud.
It supports environment variables TENCENTCLOUD_SECRET_KEY.
securityToken
Optional
- Type: string
(Optional) TencentCloud Security Token of temporary access credentials.
It supports environment variables TENCENTCLOUD_SECURITY_TOKEN.
DataTerraformRemoteStateGcsConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
bucket | string | (Required) The name of the GCS bucket. |
accessToken | string | (Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access_token will be used over the credentials field. |
credentials | string | (Optional) Local path to Google Cloud Platform account credentials in JSON format. |
encryptionKey | string | (Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state. |
impersonateServiceAccount | string | (Optional) The service account to impersonate for accessing the State Bucket. |
impersonateServiceAccountDelegates | string[] | (Optional) The delegation chain for an impersonating a service account. |
kmsEncryptionKey | string | (Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket. |
prefix | string | (Optional) GCS prefix inside the bucket. |
storeageCustomEndpoint | string | (Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b). |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
bucket
Required
- Type: string
(Required) The name of the GCS bucket.
This name must be globally unique.
accessToken
Optional
- Type: string
(Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access_token will be used over the credentials field.
credentials
Optional
- Type: string
(Optional) Local path to Google Cloud Platform account credentials in JSON format.
If unset, Google Application Default Credentials are used. The provided credentials must have Storage Object Admin role on the bucket.
Warning: if using the Google Cloud Platform provider as well, it will also pick up the GOOGLE_CREDENTIALS environment variable.
encryptionKey
Optional
- Type: string
(Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.
impersonateServiceAccount
Optional
- Type: string
(Optional) The service account to impersonate for accessing the State Bucket.
You must have roles/iam.serviceAccountTokenCreator role on that account for the impersonation to succeed. If you are using a delegation chain, you can specify that using the impersonate_service_account_delegates field. Alternatively, this can be specified using the GOOGLE_IMPERSONATE_SERVICE_ACCOUNT environment variable.
impersonateServiceAccountDelegates
Optional
- Type: string[]
(Optional) The delegation chain for an impersonating a service account.
kmsEncryptionKey
Optional
- Type: string
(Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket.
Format should be projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{name}}. For more information, including IAM requirements, see {@link https://cloud.google.com/storage/docs/encryption/customer-managed-keys Customer-managed Encryption Keys}.
prefix
Optional
- Type: string
(Optional) GCS prefix inside the bucket.
Named states for workspaces are stored in an object called < prefix >/< name >.tfstate.
storeageCustomEndpoint
Optional
- Type: string
(Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b).
{@link https://developer.hashicorp.com/terraform/language/settings/backends/gcs#storage_custom_endpoint See here for more details}
DataTerraformRemoteStateHttpConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
address | string | (Required) The address of the REST endpoint. |
clientCaCertificatePem | string | (Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication. |
clientCertificatePem | string | (Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication. |
clientPrivateKeyPem | string | (Optional) A PEM-encoded private key, required if client_certificate_pem is specified. |
lockAddress | string | (Optional) The address of the lock REST endpoint. |
lockMethod | string | (Optional) The HTTP method to use when locking. |
password | string | (Optional) The password for HTTP basic authentication. |
retryMax | number | (Optional) The number of HTTP request retries. |
retryWaitMax | number | (Optional) The maximum time in seconds to wait between HTTP request attempts. |
retryWaitMin | number | (Optional) The minimum time in seconds to wait between HTTP request attempts. |
skipCertVerification | boolean | (Optional) Whether to skip TLS verification. |
unlockAddress | string | (Optional) The address of the unlock REST endpoint. |
unlockMethod | string | (Optional) The HTTP method to use when unlocking. |
updateMethod | string | (Optional) HTTP method to use when updating state. |
username | string | (Optional) The username for HTTP basic authentication. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
address
Required
- Type: string
(Required) The address of the REST endpoint.
clientCaCertificatePem
Optional
- Type: string
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
clientCertificatePem
Optional
- Type: string
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
clientPrivateKeyPem
Optional
- Type: string
(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
lockAddress
Optional
- Type: string
(Optional) The address of the lock REST endpoint.
Defaults to disabled.
lockMethod
Optional
- Type: string
(Optional) The HTTP method to use when locking.
Defaults to LOCK.
password
Optional
- Type: string
(Optional) The password for HTTP basic authentication.
retryMax
Optional
- Type: number
(Optional) The number of HTTP request retries.
Defaults to 2.
retryWaitMax
Optional
- Type: number
(Optional) The maximum time in seconds to wait between HTTP request attempts.
Defaults to 30.
retryWaitMin
Optional
- Type: number
(Optional) The minimum time in seconds to wait between HTTP request attempts.
Defaults to 1.
skipCertVerification
Optional
- Type: boolean
(Optional) Whether to skip TLS verification.
Defaults to false.
unlockAddress
Optional
- Type: string
(Optional) The address of the unlock REST endpoint.
Defaults to disabled.
unlockMethod
Optional
- Type: string
(Optional) The HTTP method to use when unlocking.
Defaults to UNLOCK.
updateMethod
Optional
- Type: string
(Optional) HTTP method to use when updating state.
Defaults to POST.
username
Optional
- Type: string
(Optional) The username for HTTP basic authentication.
DataTerraformRemoteStateLocalConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
path | string | Path where the state file is stored. |
workspaceDir | string | (Optional) The path to non-default workspaces. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
path
Optional
- Type: string
- Default: defaults to terraform.${stackId}.tfstate
Path where the state file is stored.
workspaceDir
Optional
- Type: string
(Optional) The path to non-default workspaces.
DataTerraformRemoteStateOssConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
bucket | string | (Required) The name of the OSS bucket. |
accessKey | string | (Optional) Alibaba Cloud access key. |
acl | string | (Optional) Object ACL to be applied to the state file. |
assumeRole | OssAssumeRole | No description. |
assumeRolePolicy | string | (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. |
assumeRoleRoleArn | string | (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials. |
assumeRoleSessionExpiration | number | (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION. |
assumeRoleSessionName | string | (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME. |
ecsRoleName | string | (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. |
encrypt | boolean | (Optional) Whether to enable server side encryption of the state file. |
endpoint | string | (Optional) A custom endpoint for the OSS API. |
key | string | (Optional) The name of the state file. |
prefix | string | (Optional) The path directory of the state file will be stored. |
profile | string | (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable. |
region | string | (Optional) The region of the OSS bucket. |
secretKey | string | (Optional) Alibaba Cloud secret access key. |
securityToken | string | (Optional) STS access token. |
sharedCredentialsFile | string | (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used. |
stsEndpoint | string | (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT. |
tablestoreEndpoint | string | (Optional) A custom endpoint for the TableStore API. |
tablestoreTable | string | (Optional) A TableStore table for state locking and consistency. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
bucket
Required
- Type: string
(Required) The name of the OSS bucket.
accessKey
Optional
- Type: string
(Optional) Alibaba Cloud access key.
It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.
acl
Optional
- Type: string
(Optional) Object ACL to be applied to the state file.
assumeRole
Optional
assumeRole
- Deprecated: Use flattened assume role options
- Type: OssAssumeRole
assumeRolePolicy
Optional
- Type: string
(Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.
assumeRoleRoleArn
Optional
- Type: string
(Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials.
assumeRoleSessionExpiration
Optional
- Type: number
(Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.
assumeRoleSessionName
Optional
- Type: string
(Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME.
ecsRoleName
Optional
- Type: string
(Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.
encrypt
Optional
- Type: boolean
(Optional) Whether to enable server side encryption of the state file.
If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file.
endpoint
Optional
- Type: string
(Optional) A custom endpoint for the OSS API.
It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.
key
Optional
- Type: string
(Optional) The name of the state file.
Defaults to terraform.tfstate.
prefix
Optional
- Type: string
(Optional) The path directory of the state file will be stored.
Default to "env:".
profile
Optional
- Type: string
(Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable.
region
Optional
- Type: string
(Optional) The region of the OSS bucket.
It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.
secretKey
Optional
- Type: string
(Optional) Alibaba Cloud secret access key.
It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.
securityToken
Optional
- Type: string
(Optional) STS access token.
It supports environment variable ALICLOUD_SECURITY_TOKEN.
sharedCredentialsFile
Optional
- Type: string
(Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used.
stsEndpoint
Optional
- Type: string
(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.
tablestoreEndpoint
Optional
- Type: string
(Optional) A custom endpoint for the TableStore API.
tablestoreTable
Optional
- Type: string
(Optional) A TableStore table for state locking and consistency.
The table must have a primary key named LockID of type String.
DataTerraformRemoteStatePgConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
connStr | string | Postgres connection string; |
schemaName | string | Name of the automatically-managed Postgres schema, default to terraform_remote_state. |
skipIndexCreation | boolean | If set to true, the Postgres index must already exist. |
skipSchemaCreation | boolean | If set to true, the Postgres schema must already exist. |
skipTableCreation | boolean | If set to true, the Postgres table must already exist. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
connStr
Required
- Type: string
Postgres connection string;
a postgres:// URL. The PG_CONN_STR and standard libpq environment variables can also be used to indicate how to connect to the PostgreSQL database.
schemaName
Optional
- Type: string
Name of the automatically-managed Postgres schema, default to terraform_remote_state.
Can also be set using the PG_SCHEMA_NAME environment variable.
skipIndexCreation
Optional
- Type: boolean
If set to true, the Postgres index must already exist.
Can also be set using the PG_SKIP_INDEX_CREATION environment variable. Terraform won't try to create the index, this is useful when it has already been created by a database administrator.
skipSchemaCreation
Optional
- Type: boolean
If set to true, the Postgres schema must already exist.
Can also be set using the PG_SKIP_SCHEMA_CREATION environment variable. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator.
skipTableCreation
Optional
- Type: boolean
If set to true, the Postgres table must already exist.
Can also be set using the PG_SKIP_TABLE_CREATION environment variable. Terraform won't try to create the table, this is useful when it has already been created by a database administrator.
DataTerraformRemoteStateRemoteConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
organization | string | No description. |
workspaces | IRemoteWorkspace | No description. |
hostname | string | No description. |
token | string | No description. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
organization
Required
- Type: string
workspaces
Required
- Type: IRemoteWorkspace
hostname
Optional
- Type: string
token
Optional
- Type: string
DataTerraformRemoteStateS3Config
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
bucket | string | Name of the S3 Bucket. |
key | string | Path to the state file inside the S3 Bucket. |
accessKey | string | (Optional) AWS access key. |
acl | string | (Optional) Canned ACL to be applied to the state file. |
allowedAccountIds | string | (Optional) List of allowed AWS account IDs to prevent potential destruction of a live environment. |
assumeRole | S3BackendAssumeRoleConfig | Assuming an IAM Role can be configured in two ways. |
assumeRolePolicy | string | (Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed. |
assumeRolePolicyArns | string[] | (Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed. |
assumeRoleTags | {[ key: string ]: string} | (Optional) Map of assume role session tags. |
assumeRoleTransitiveTagKeys | string[] | (Optional) Set of assume role session tag keys to pass to any subsequent sessions. |
assumeRoleWithWebIdentity | S3BackendAssumeRoleWithWebIdentityConfig | Assume Role With Web Identity Configuration. |
customCaBundle | string | (Optional) File containing custom root and intermediate certificates. |
dynamodbEndpoint | string | (Optional) Custom endpoint for the AWS DynamoDB API. |
dynamodbTable | string | (Optional) Name of DynamoDB Table to use for state locking and consistency. |
ec2MetadataServiceEndpoint | string | Optional) Custom endpoint URL for the EC2 Instance Metadata Service (IMDS) API. |
ec2MetadataServiceEndpointMode | string | (Optional) Mode to use in communicating with the metadata service. |
encrypt | boolean | (Optional) Enable server side encryption of the state file. |
endpoint | string | (Optional) Custom endpoint for the AWS S3 API. |
endpoints | S3BackendEndpointConfig | (Optional) The endpoint configuration block. |
externalId | string | (Optional) External identifier to use when assuming the role. |
forbiddenAccountIds | string | (Optional) List of forbidden AWS account IDs to prevent potential destruction of a live environment. |
forcePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
httpProxy | string | (Optional) URL of a proxy to use for HTTP requests when accessing the AWS API. |
httpsProxy | string | (Optional) URL of a proxy to use for HTTPS requests when accessing the AWS API. |
iamEndpoint | string | (Optional) Custom endpoint for the AWS Identity and Access Management (IAM) API. |
insecure | boolean | Optional) Whether to explicitly allow the backend to perform "insecure" SSL requests. |
kmsKeyId | string | (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. |
maxRetries | number | (Optional) The maximum number of times an AWS API request is retried on retryable failure. |
noProxy | string | (Optional) Comma-separated list of hosts that should not use HTTP or HTTPS proxies. |
profile | string | (Optional) Name of AWS profile in AWS shared credentials file (e.g. ~/.aws/credentials) or AWS shared configuration file (e.g. ~/.aws/config) to use for credentials and/or configuration. This can also be sourced from the AWS_PROFILE environment variable. |
region | string | AWS Region of the S3 Bucket and DynamoDB Table (if used). |
retryMode | string | (Optional) Specifies how retries are attempted. |
roleArn | string | (Optional) Amazon Resource Name (ARN) of the IAM Role to assume. |
secretKey | string | (Optional) AWS secret access key. |
sessionName | string | (Optional) Session name to use when assuming the role. |
sharedConfigFiles | string[] | (Optional) List of paths to AWS shared configuration files. |
sharedCredentialsFile | string | (Optional) Path to the AWS shared credentials file. |
sharedCredentialsFiles | string[] | (Optional) List of paths to AWS shared credentials files. |
skipCredentialsValidation | boolean | (Optional) Skip credentials validation via the STS API. |
skipMetadataApiCheck | boolean | (Optional) Skip usage of EC2 Metadata API. |
skipRegionValidation | boolean | (Optional) Skip validation of provided region name. |
skipRequestingAccountId | boolean | (Optional) Whether to skip requesting the account ID. |
skipS3Checksum | boolean | (Optional) Do not include checksum when uploading S3 Objects. |
sseCustomerKey | string | (Optional) The key to use for encrypting state with Server-Side Encryption with Customer-Provided Keys (SSE-C). |
stsEndpoint | string | (Optional) Custom endpoint for the AWS Security Token Service (STS) API. |
stsRegion | string | (Optional) AWS region for STS. |
token | string | (Optional) Multi-Factor Authentication (MFA) token. |
useLegacyWorkflow | boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. |
usePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
workspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. |
defaults
Optional
- Type: {[ key: string ]: any}
workspace
Optional
- Type: string
bucket
Required
- Type: string
Name of the S3 Bucket.
key
Required
- Type: string
Path to the state file inside the S3 Bucket.
When using a non-default workspace, the state path will be /workspace_key_prefix/workspace_name/key
accessKey
Optional
- Type: string
(Optional) AWS access key.
If configured, must also configure secret_key. This can also be sourced from the AWS_ACCESS_KEY_ID environment variable, AWS shared credentials file (e.g. ~/.aws/credentials), or AWS shared configuration file (e.g. ~/.aws/config).
acl
Optional
- Type: string
(Optional) Canned ACL to be applied to the state file.
allowedAccountIds
Optional
- Type: string
(Optional) List of allowed AWS account IDs to prevent potential destruction of a live environment.
Conflicts with forbidden_account_ids.
assumeRole
Optional
Assuming an IAM Role can be configured in two ways.
The preferred way is to use the argument assume_role, the other, which is deprecated, is with arguments at the top level.
assumeRolePolicy
Optional
assumeRolePolicy
- Deprecated: Use assumeRole.policy instead.
- Type: string
(Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
assumeRolePolicyArns
Optional
assumeRolePolicyArns
- Deprecated: Use assumeRole.policyArns instead.
- Type: string[]
(Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
assumeRoleTags
Optional
assumeRoleTags
- Deprecated: Use assumeRole.tags instead.
- Type: {[ key: string ]: string}
(Optional) Map of assume role session tags.
assumeRoleTransitiveTagKeys
Optional
assumeRoleTransitiveTagKeys
- Deprecated: Use assumeRole.transitiveTagKeys instead.
- Type: string[]
(Optional) Set of assume role session tag keys to pass to any subsequent sessions.
assumeRoleWithWebIdentity
Optional
Assume Role With Web Identity Configuration.
customCaBundle
Optional
- Type: string
(Optional) File containing custom root and intermediate certificates.
Can also be set using the AWS_CA_BUNDLE environment variable. Setting ca_bundle in the shared config file is not supported.
dynamodbEndpoint
Optional
dynamodbEndpoint
- Deprecated: Use endpoints.dynamodb instead
- Type: string
(Optional) Custom endpoint for the AWS DynamoDB API.
This can also be sourced from the AWS_DYNAMODB_ENDPOINT environment variable.
dynamodbTable
Optional
- Type: string
(Optional) Name of DynamoDB Table to use for state locking and consistency.
The table must have a partition key named LockID with type of String. If not configured, state locking will be disabled.
ec2MetadataServiceEndpoint
Optional
- Type: string
Optional) Custom endpoint URL for the EC2 Instance Metadata Service (IMDS) API.
Can also be set with the AWS_EC2_METADATA_SERVICE_ENDPOINT environment variable.
ec2MetadataServiceEndpointMode
Optional
- Type: string
(Optional) Mode to use in communicating with the metadata service.
Valid values are IPv4 and IPv6. Can also be set with the AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE environment variable.
encrypt
Optional
- Type: boolean
(Optional) Enable server side encryption of the state file.
endpoint
Optional
endpoint
- Deprecated: Use endpoints.s3 instead
- Type: string
(Optional) Custom endpoint for the AWS S3 API.
This can also be sourced from the AWS_S3_ENDPOINT environment variable.
endpoints
Optional
- Type: S3BackendEndpointConfig
(Optional) The endpoint configuration block.
externalId
Optional
externalId
- Deprecated: Use assume_role.external_id instead.
- Type: string
(Optional) External identifier to use when assuming the role.
forbiddenAccountIds
Optional
- Type: string
(Optional) List of forbidden AWS account IDs to prevent potential destruction of a live environment.
Conflicts with allowed_account_ids.
forcePathStyle
Optional
forcePathStyle
- Deprecated: Use usePathStyle instead
- Type: boolean
(Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >).
httpProxy
Optional
- Type: string
(Optional) URL of a proxy to use for HTTP requests when accessing the AWS API.
Can also be set using the HTTP_PROXY or http_proxy environment variables.
httpsProxy
Optional
- Type: string
(Optional) URL of a proxy to use for HTTPS requests when accessing the AWS API.
Can also be set using the HTTPS_PROXY or https_proxy environment variables.
iamEndpoint
Optional
iamEndpoint
- Deprecated: Use endpoints.iam instead
- Type: string
(Optional) Custom endpoint for the AWS Identity and Access Management (IAM) API.
This can also be sourced from the AWS_IAM_ENDPOINT environment variable.
insecure
Optional
- Type: boolean
Optional) Whether to explicitly allow the backend to perform "insecure" SSL requests.
If omitted, the default value is false.
kmsKeyId
Optional
- Type: string
(Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state.
Note that if this value is specified, Terraform will need kms:Encrypt, kms:Decrypt and kms:GenerateDataKey permissions on this KMS key.
maxRetries
Optional
- Type: number
(Optional) The maximum number of times an AWS API request is retried on retryable failure.
Defaults to 5.
noProxy
Optional
- Type: string
(Optional) Comma-separated list of hosts that should not use HTTP or HTTPS proxies.
Each value can be one of:
- A domain name
- An IP address
- A CIDR address
- An asterisk (*), to indicate that no proxying should be performed Domain name and IP address values can also include a port number. Can also be set using the NO_PROXY or no_proxy environment variables.
profile
Optional
- Type: string
(Optional) Name of AWS profile in AWS shared credentials file (e.g. ~/.aws/credentials) or AWS shared configuration file (e.g. ~/.aws/config) to use for credentials and/or configuration. This can also be sourced from the AWS_PROFILE environment variable.
region
Optional
- Type: string
AWS Region of the S3 Bucket and DynamoDB Table (if used).
This can also be sourced from the AWS_DEFAULT_REGION and AWS_REGION environment variables.
retryMode
Optional
- Type: string
(Optional) Specifies how retries are attempted.
Valid values are standard and adaptive. Can also be configured using the AWS_RETRY_MODE environment variable or the shared config file parameter retry_mode.
roleArn
Optional
roleArn
- Deprecated: Use assumeRole.roleArn instead.
- Type: string
(Optional) Amazon Resource Name (ARN) of the IAM Role to assume.
secretKey
Optional
- Type: string
(Optional) AWS secret access key.
If configured, must also configure access_key. This can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, AWS shared credentials file (e.g. ~/.aws/credentials), or AWS shared configuration file (e.g. ~/.aws/config)
sessionName
Optional
sessionName
- Deprecated: Use assumeRole.sessionName instead.
- Type: string
(Optional) Session name to use when assuming the role.
sharedConfigFiles
Optional
- Type: string[]
(Optional) List of paths to AWS shared configuration files.
Defaults to ~/.aws/config.
sharedCredentialsFile
Optional
- Type: string
(Optional) Path to the AWS shared credentials file.
Defaults to ~/.aws/credentials.
sharedCredentialsFiles
Optional
- Type: string[]
(Optional) List of paths to AWS shared credentials files.
Defaults to ~/.aws/credentials.
skipCredentialsValidation
Optional
- Type: boolean
(Optional) Skip credentials validation via the STS API.
skipMetadataApiCheck
Optional
- Type: boolean
(Optional) Skip usage of EC2 Metadata API.
skipRegionValidation
Optional
- Type: boolean
(Optional) Skip validation of provided region name.
skipRequestingAccountId
Optional
- Type: boolean
(Optional) Whether to skip requesting the account ID.
Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
skipS3Checksum
Optional
- Type: boolean
(Optional) Do not include checksum when uploading S3 Objects.
Useful for some S3-Compatible APIs.
sseCustomerKey
Optional
- Type: string
(Optional) The key to use for encrypting state with Server-Side Encryption with Customer-Provided Keys (SSE-C).
This is the base64-encoded value of the key, which must decode to 256 bits. This can also be sourced from the AWS_SSE_CUSTOMER_KEY environment variable, which is recommended due to the sensitivity of the value. Setting it inside a terraform file will cause it to be persisted to disk in terraform.tfstate.
stsEndpoint
Optional
stsEndpoint
- Deprecated: Use endpoints.sts instead
- Type: string
(Optional) Custom endpoint for the AWS Security Token Service (STS) API.
This can also be sourced from the AWS_STS_ENDPOINT environment variable.
stsRegion
Optional
- Type: string
(Optional) AWS region for STS.
If unset, AWS will use the same region for STS as other non-STS operations.
token
Optional
- Type: string
(Optional) Multi-Factor Authentication (MFA) token.
This can also be sourced from the AWS_SESSION_TOKEN environment variable.
useLegacyWorkflow
Optional
- Type: boolean
(Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration.
Defaults to true. This behavior does not align with the authentication flow of the AWS CLI or SDK's, and will be removed in the future.
usePathStyle
Optional
- Type: boolean
(Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >).
workspaceKeyPrefix
Optional
- Type: string
(Optional) Prefix applied to the state path inside the bucket.
This is only relevant when using a non-default workspace. Defaults to env:
DataTerraformRemoteStateSwiftConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
defaults | {[ key: string ]: any} | No description. |
workspace | string | No description. |
container | string | No description. |
applicationCredentialId | string | No description. |
applicationCredentialName | string | No description. |
applicationCredentialSecret | string | No description. |
archiveContainer | string | No description. |
authUrl | string | No description. |
cacertFile | string | No description. |
cert | string | No description. |
cloud | string | No description. |
defaultDomain | string | No description. |
domainId | string | No description. |
domainName | string | No description. |
expireAfter | string | No description. |
insecure | boolean | No description. |
key | string | No description. |
password | string | No description. |
projectDomainId | string | No description. |
projectDomainName | string | No description. |
regionName | string | No description. |
stateName | string | No description. |
tenantId | string | No description. |
tenantName | string | No description. |
token | string | No description. |
userDomainId | string | No description. |
userDomainName | string | No description. |
userId | string | No description. |
userName | string | No description. |
defaults
Optional
defaults
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: {[ key: string ]: any}
workspace
Optional
workspace
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
container
Required
container
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
applicationCredentialId
Optional
applicationCredentialId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
applicationCredentialName
Optional
applicationCredentialName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
applicationCredentialSecret
Optional
applicationCredentialSecret
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
archiveContainer
Optional
archiveContainer
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
authUrl
Optional
authUrl
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
cacertFile
Optional
cacertFile
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
cert
Optional
cert
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
cloud
Optional
cloud
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
defaultDomain
Optional
defaultDomain
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
domainId
Optional
domainId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
domainName
Optional
domainName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
expireAfter
Optional
expireAfter
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
insecure
Optional
insecure
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: boolean
key
Optional
key
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
password
Optional
password
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
projectDomainId
Optional
projectDomainId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
projectDomainName
Optional
projectDomainName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
regionName
Optional
regionName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
stateName
Optional
stateName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
tenantId
Optional
tenantId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
tenantName
Optional
tenantName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
token
Optional
token
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userDomainId
Optional
userDomainId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userDomainName
Optional
userDomainName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userId
Optional
userId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userName
Optional
userName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
EncodingOptions
Properties to string encodings.
Initializer
Properties
Name | Type | Description |
---|---|---|
displayHint | string | A hint for the Token's purpose when stringifying it. |
displayHint
Optional
- Type: string
- Default: no display hint
A hint for the Token's purpose when stringifying it.
FileProvisioner
The file provisioner copies files or directories from the machine running Terraform to the newly created resource.
The file provisioner supports both ssh and winrm type connections.
See {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/file file}
Initializer
Properties
Name | Type | Description |
---|---|---|
destination | string | The source file or directory. |
type | string | No description. |
connection | SSHProvisionerConnection | WinrmProvisionerConnection | Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. |
content | string | The destination path to write to on the remote system. |
source | string | The direct content to copy on the destination. |
destination
Required
- Type: string
The source file or directory.
Specify it either relative to the current working directory or as an absolute path. This argument cannot be combined with content.
type
Required
- Type: string
connection
Optional
Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.
content
Optional
- Type: string
The destination path to write to on the remote system.
See Destination Paths below for more information.
source
Optional
- Type: string
The direct content to copy on the destination.
If destination is a file, the content will be written on that file. In case of a directory, a file named tf-file-content is created inside that directory. We recommend using a file as the destination when using content. This argument cannot be combined with source.
GcsBackendConfig
Stores the state as an object in a configurable prefix in a pre-existing bucket on Google Cloud Storage (GCS).
The bucket must exist prior to configuring the backend.
This backend supports state locking.
Warning! It is highly recommended that you enable Object Versioning on the GCS bucket to allow for state recovery in the case of accidental deletions and human error.
Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/gcs
Initializer
Properties
Name | Type | Description |
---|---|---|
bucket | string | (Required) The name of the GCS bucket. |
accessToken | string | (Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access_token will be used over the credentials field. |
credentials | string | (Optional) Local path to Google Cloud Platform account credentials in JSON format. |
encryptionKey | string | (Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state. |
impersonateServiceAccount | string | (Optional) The service account to impersonate for accessing the State Bucket. |
impersonateServiceAccountDelegates | string[] | (Optional) The delegation chain for an impersonating a service account. |
kmsEncryptionKey | string | (Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket. |
prefix | string | (Optional) GCS prefix inside the bucket. |
storeageCustomEndpoint | string | (Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b). |
bucket
Required
- Type: string
(Required) The name of the GCS bucket.
This name must be globally unique.
accessToken
Optional
- Type: string
(Optional) A temporary [OAuth 2.0 access token] obtained from the Google Authorization server, i.e. the Authorization: Bearer token used to authenticate HTTP requests to GCP APIs. This is an alternative to credentials. If both are specified, access_token will be used over the credentials field.
credentials
Optional
- Type: string
(Optional) Local path to Google Cloud Platform account credentials in JSON format.
If unset, Google Application Default Credentials are used. The provided credentials must have Storage Object Admin role on the bucket.
Warning: if using the Google Cloud Platform provider as well, it will also pick up the GOOGLE_CREDENTIALS environment variable.
encryptionKey
Optional
- Type: string
(Optional) A 32 byte base64 encoded 'customer supplied encryption key' used to encrypt all state.
impersonateServiceAccount
Optional
- Type: string
(Optional) The service account to impersonate for accessing the State Bucket.
You must have roles/iam.serviceAccountTokenCreator role on that account for the impersonation to succeed. If you are using a delegation chain, you can specify that using the impersonate_service_account_delegates field. Alternatively, this can be specified using the GOOGLE_IMPERSONATE_SERVICE_ACCOUNT environment variable.
impersonateServiceAccountDelegates
Optional
- Type: string[]
(Optional) The delegation chain for an impersonating a service account.
kmsEncryptionKey
Optional
- Type: string
(Optional) A Cloud KMS key ('customer-managed encryption key') used when reading and writing state files in the bucket.
Format should be projects/{{project}}/locations/{{location}}/keyRings/{{keyRing}}/cryptoKeys/{{name}}. For more information, including IAM requirements, see {@link https://cloud.google.com/storage/docs/encryption/customer-managed-keys Customer-managed Encryption Keys}.
prefix
Optional
- Type: string
(Optional) GCS prefix inside the bucket.
Named states for workspaces are stored in an object called < prefix >/< name >.tfstate.
storeageCustomEndpoint
Optional
- Type: string
(Optional) A URL containing three parts: the protocol, the DNS name pointing to a Private Service Connect endpoint, and the path for the Cloud Storage API (/storage/v1/b).
{@link https://developer.hashicorp.com/terraform/language/settings/backends/gcs#storage_custom_endpoint See here for more details}
HttpBackendConfig
Stores the state using a simple REST client.
State will be fetched via GET, updated via POST, and purged with DELETE. The method used for updating is configurable.
This backend optionally supports state locking. When locking support is enabled it will use LOCK and UNLOCK requests providing the lock info in the body. The endpoint should return a 423: Locked or 409: Conflict with the holding lock info when it's already taken, 200: OK for success. Any other status will be considered an error. The ID of the holding lock info will be added as a query parameter to state updates requests.
Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/http
Initializer
Properties
Name | Type | Description |
---|---|---|
address | string | (Required) The address of the REST endpoint. |
clientCaCertificatePem | string | (Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication. |
clientCertificatePem | string | (Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication. |
clientPrivateKeyPem | string | (Optional) A PEM-encoded private key, required if client_certificate_pem is specified. |
lockAddress | string | (Optional) The address of the lock REST endpoint. |
lockMethod | string | (Optional) The HTTP method to use when locking. |
password | string | (Optional) The password for HTTP basic authentication. |
retryMax | number | (Optional) The number of HTTP request retries. |
retryWaitMax | number | (Optional) The maximum time in seconds to wait between HTTP request attempts. |
retryWaitMin | number | (Optional) The minimum time in seconds to wait between HTTP request attempts. |
skipCertVerification | boolean | (Optional) Whether to skip TLS verification. |
unlockAddress | string | (Optional) The address of the unlock REST endpoint. |
unlockMethod | string | (Optional) The HTTP method to use when unlocking. |
updateMethod | string | (Optional) HTTP method to use when updating state. |
username | string | (Optional) The username for HTTP basic authentication. |
address
Required
- Type: string
(Required) The address of the REST endpoint.
clientCaCertificatePem
Optional
- Type: string
(Optional) A PEM-encoded CA certificate chain used by the client to verify server certificates during TLS authentication.
clientCertificatePem
Optional
- Type: string
(Optional) A PEM-encoded certificate used by the server to verify the client during mutual TLS (mTLS) authentication.
clientPrivateKeyPem
Optional
- Type: string
(Optional) A PEM-encoded private key, required if client_certificate_pem is specified.
lockAddress
Optional
- Type: string
(Optional) The address of the lock REST endpoint.
Defaults to disabled.
lockMethod
Optional
- Type: string
(Optional) The HTTP method to use when locking.
Defaults to LOCK.
password
Optional
- Type: string
(Optional) The password for HTTP basic authentication.
retryMax
Optional
- Type: number
(Optional) The number of HTTP request retries.
Defaults to 2.
retryWaitMax
Optional
- Type: number
(Optional) The maximum time in seconds to wait between HTTP request attempts.
Defaults to 30.
retryWaitMin
Optional
- Type: number
(Optional) The minimum time in seconds to wait between HTTP request attempts.
Defaults to 1.
skipCertVerification
Optional
- Type: boolean
(Optional) Whether to skip TLS verification.
Defaults to false.
unlockAddress
Optional
- Type: string
(Optional) The address of the unlock REST endpoint.
Defaults to disabled.
unlockMethod
Optional
- Type: string
(Optional) The HTTP method to use when unlocking.
Defaults to UNLOCK.
updateMethod
Optional
- Type: string
(Optional) HTTP method to use when updating state.
Defaults to POST.
username
Optional
- Type: string
(Optional) The username for HTTP basic authentication.
LazyAnyValueOptions
Options for creating lazy untyped tokens.
Initializer
Properties
Name | Type | Description |
---|---|---|
displayHint | string | Use the given name as a display hint. |
omitEmptyArray | boolean | If the produced value is an array and it is empty, return 'undefined' instead. |
displayHint
Optional
- Type: string
- Default: No hint
Use the given name as a display hint.
omitEmptyArray
Optional
- Type: boolean
- Default: false
If the produced value is an array and it is empty, return 'undefined' instead.
LazyListValueOptions
Options for creating a lazy list token.
Initializer
Properties
Name | Type | Description |
---|---|---|
displayHint | string | Use the given name as a display hint. |
omitEmpty | boolean | If the produced list is empty, return 'undefined' instead. |
displayHint
Optional
- Type: string
- Default: No hint
Use the given name as a display hint.
omitEmpty
Optional
- Type: boolean
- Default: false
If the produced list is empty, return 'undefined' instead.
LazyStringValueOptions
Options for creating a lazy string token.
Initializer
Properties
Name | Type | Description |
---|---|---|
displayHint | string | Use the given name as a display hint. |
displayHint
Optional
- Type: string
- Default: No hint
Use the given name as a display hint.
LocalBackendConfig
The local backend stores state on the local filesystem, locks that state using system APIs, and performs operations locally.
Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/local
Initializer
Properties
Name | Type | Description |
---|---|---|
path | string | Path where the state file is stored. |
workspaceDir | string | (Optional) The path to non-default workspaces. |
path
Optional
- Type: string
- Default: defaults to terraform.${stackId}.tfstate
Path where the state file is stored.
workspaceDir
Optional
- Type: string
(Optional) The path to non-default workspaces.
LocalExecProvisioner
The local-exec provisioner invokes a local executable after a resource is created.
This invokes a process on the machine running Terraform, not on the resource.
See {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/local-exec local-exec}
Initializer
Properties
Name | Type | Description |
---|---|---|
command | string | This is the command to execute. |
type | string | No description. |
environment | {[ key: string ]: string} | A record of key value pairs representing the environment of the executed command. |
interpreter | string[] | If provided, this is a list of interpreter arguments used to execute the command. |
when | string | If provided, specifies when Terraform will execute the command. |
workingDir | string | If provided, specifies the working directory where command will be executed. |
command
Required
- Type: string
This is the command to execute.
It can be provided as a relative path to the current working directory or as an absolute path. It is evaluated in a shell, and can use environment variables or Terraform variables.
type
Required
- Type: string
environment
Optional
- Type: {[ key: string ]: string}
A record of key value pairs representing the environment of the executed command.
It inherits the current process environment.
interpreter
Optional
- Type: string[]
If provided, this is a list of interpreter arguments used to execute the command.
The first argument is the interpreter itself. It can be provided as a relative path to the current working directory or as an absolute path The remaining arguments are appended prior to the command. This allows building command lines of the form "/bin/bash", "-c", "echo foo". If interpreter is unspecified, sensible defaults will be chosen based on the system OS.
when
Optional
- Type: string
If provided, specifies when Terraform will execute the command.
For example, when = destroy specifies that the provisioner will run when the associated resource is destroyed
workingDir
Optional
- Type: string
If provided, specifies the working directory where command will be executed.
It can be provided as a relative path to the current working directory or as an absolute path. The directory must exist.
OssAssumeRole
Initializer
Properties
Name | Type | Description |
---|---|---|
roleArn | string | No description. |
policy | string | No description. |
sessionExpiration | number | No description. |
sessionName | string | No description. |
roleArn
Required
- Type: string
policy
Optional
- Type: string
sessionExpiration
Optional
- Type: number
sessionName
Optional
- Type: string
OssBackendConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
bucket | string | (Required) The name of the OSS bucket. |
accessKey | string | (Optional) Alibaba Cloud access key. |
acl | string | (Optional) Object ACL to be applied to the state file. |
assumeRole | OssAssumeRole | No description. |
assumeRolePolicy | string | (Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed. |
assumeRoleRoleArn | string | (Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials. |
assumeRoleSessionExpiration | number | (Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION. |
assumeRoleSessionName | string | (Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME. |
ecsRoleName | string | (Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console. |
encrypt | boolean | (Optional) Whether to enable server side encryption of the state file. |
endpoint | string | (Optional) A custom endpoint for the OSS API. |
key | string | (Optional) The name of the state file. |
prefix | string | (Optional) The path directory of the state file will be stored. |
profile | string | (Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable. |
region | string | (Optional) The region of the OSS bucket. |
secretKey | string | (Optional) Alibaba Cloud secret access key. |
securityToken | string | (Optional) STS access token. |
sharedCredentialsFile | string | (Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used. |
stsEndpoint | string | (Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT. |
tablestoreEndpoint | string | (Optional) A custom endpoint for the TableStore API. |
tablestoreTable | string | (Optional) A TableStore table for state locking and consistency. |
bucket
Required
- Type: string
(Required) The name of the OSS bucket.
accessKey
Optional
- Type: string
(Optional) Alibaba Cloud access key.
It supports environment variables ALICLOUD_ACCESS_KEY and ALICLOUD_ACCESS_KEY_ID.
acl
Optional
- Type: string
(Optional) Object ACL to be applied to the state file.
assumeRole
Optional
assumeRole
- Deprecated: Use flattened assume role options
- Type: OssAssumeRole
assumeRolePolicy
Optional
- Type: string
(Optional, Available in 1.1.0+) A more restrictive policy to apply to the temporary credentials. This gives you a way to further restrict the permissions for the resulting temporary security credentials. You cannot use this policy to grant permissions that exceed those of the role that is being assumed.
assumeRoleRoleArn
Optional
- Type: string
(Optional, Available in 1.1.0+) The ARN of the role to assume. If ARN is set to an empty string, it does not perform role switching. It supports the environment variable ALICLOUD_ASSUME_ROLE_ARN. Terraform executes configuration on account with provided credentials.
assumeRoleSessionExpiration
Optional
- Type: number
(Optional, Available in 1.1.0+) The time after which the established session for assuming role expires. Valid value range: [900-3600] seconds. Default to 3600 (in this case Alibaba Cloud uses its own default value). It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_EXPIRATION.
assumeRoleSessionName
Optional
- Type: string
(Optional, Available in 1.1.0+) The session name to use when assuming the role. If omitted, 'terraform' is passed to the AssumeRole call as session name. It supports environment variable ALICLOUD_ASSUME_ROLE_SESSION_NAME.
ecsRoleName
Optional
- Type: string
(Optional, Available in 0.12.14+) The RAM Role Name attached on a ECS instance for API operations. You can retrieve this from the 'Access Control' section of the Alibaba Cloud console.
encrypt
Optional
- Type: boolean
(Optional) Whether to enable server side encryption of the state file.
If it is true, OSS will use 'AES256' encryption algorithm to encrypt state file.
endpoint
Optional
- Type: string
(Optional) A custom endpoint for the OSS API.
It supports environment variables ALICLOUD_OSS_ENDPOINT and OSS_ENDPOINT.
key
Optional
- Type: string
(Optional) The name of the state file.
Defaults to terraform.tfstate.
prefix
Optional
- Type: string
(Optional) The path directory of the state file will be stored.
Default to "env:".
profile
Optional
- Type: string
(Optional, Available in 0.12.8+) This is the Alibaba Cloud profile name as set in the shared credentials file. It can also be sourced from the ALICLOUD_PROFILE environment variable.
region
Optional
- Type: string
(Optional) The region of the OSS bucket.
It supports environment variables ALICLOUD_REGION and ALICLOUD_DEFAULT_REGION.
secretKey
Optional
- Type: string
(Optional) Alibaba Cloud secret access key.
It supports environment variables ALICLOUD_SECRET_KEY and ALICLOUD_ACCESS_KEY_SECRET.
securityToken
Optional
- Type: string
(Optional) STS access token.
It supports environment variable ALICLOUD_SECURITY_TOKEN.
sharedCredentialsFile
Optional
- Type: string
(Optional, Available in 0.12.8+) This is the path to the shared credentials file. It can also be sourced from the ALICLOUD_SHARED_CREDENTIALS_FILE environment variable. If this is not set and a profile is specified, ~/.aliyun/config.json will be used.
stsEndpoint
Optional
- Type: string
(Optional, Available in 1.0.11+) Custom endpoint for the AliCloud Security Token Service (STS) API. It supports environment variable ALICLOUD_STS_ENDPOINT.
tablestoreEndpoint
Optional
- Type: string
(Optional) A custom endpoint for the TableStore API.
tablestoreTable
Optional
- Type: string
(Optional) A TableStore table for state locking and consistency.
The table must have a primary key named LockID of type String.
PgBackendConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
connStr | string | Postgres connection string; |
schemaName | string | Name of the automatically-managed Postgres schema, default to terraform_remote_state. |
skipIndexCreation | boolean | If set to true, the Postgres index must already exist. |
skipSchemaCreation | boolean | If set to true, the Postgres schema must already exist. |
skipTableCreation | boolean | If set to true, the Postgres table must already exist. |
connStr
Required
- Type: string
Postgres connection string;
a postgres:// URL. The PG_CONN_STR and standard libpq environment variables can also be used to indicate how to connect to the PostgreSQL database.
schemaName
Optional
- Type: string
Name of the automatically-managed Postgres schema, default to terraform_remote_state.
Can also be set using the PG_SCHEMA_NAME environment variable.
skipIndexCreation
Optional
- Type: boolean
If set to true, the Postgres index must already exist.
Can also be set using the PG_SKIP_INDEX_CREATION environment variable. Terraform won't try to create the index, this is useful when it has already been created by a database administrator.
skipSchemaCreation
Optional
- Type: boolean
If set to true, the Postgres schema must already exist.
Can also be set using the PG_SKIP_SCHEMA_CREATION environment variable. Terraform won't try to create the schema, this is useful when it has already been created by a database administrator.
skipTableCreation
Optional
- Type: boolean
If set to true, the Postgres table must already exist.
Can also be set using the PG_SKIP_TABLE_CREATION environment variable. Terraform won't try to create the table, this is useful when it has already been created by a database administrator.
Postcondition
Terraform checks a postcondition after evaluating the object it is associated with.
Initializer
Properties
Name | Type | Description |
---|---|---|
condition | any | This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not. |
errorMessage | string | This contains the text that Terraform will include as part of error messages when it detects an unmet condition. |
condition
Required
- Type: any
This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not.
errorMessage
Required
- Type: string
This contains the text that Terraform will include as part of error messages when it detects an unmet condition.
Precondition
Terraform checks a precondition before evaluating the object it is associated with.
Initializer
Properties
Name | Type | Description |
---|---|---|
condition | any | This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not. |
errorMessage | string | This contains the text that Terraform will include as part of error messages when it detects an unmet condition. |
condition
Required
- Type: any
This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not.
errorMessage
Required
- Type: string
This contains the text that Terraform will include as part of error messages when it detects an unmet condition.
RemoteBackendConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
organization | string | No description. |
workspaces | IRemoteWorkspace | No description. |
hostname | string | No description. |
token | string | No description. |
organization
Required
- Type: string
workspaces
Required
- Type: IRemoteWorkspace
hostname
Optional
- Type: string
token
Optional
- Type: string
RemoteExecProvisioner
The remote-exec provisioner invokes a script on a remote resource after it is created.
This can be used to run a configuration management tool, bootstrap into a cluster, etc The remote-exec provisioner requires a connection and supports both ssh and winrm.
See {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/remote-exec remote-exec}
Initializer
Properties
Name | Type | Description |
---|---|---|
type | string | No description. |
connection | SSHProvisionerConnection | WinrmProvisionerConnection | Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. |
inline | string[] | This is a list of command strings. |
script | string | This is a path (relative or absolute) to a local script that will be copied to the remote resource and then executed. |
scripts | string[] | This is a list of paths (relative or absolute) to local scripts that will be copied to the remote resource and then executed. |
type
Required
- Type: string
connection
Optional
Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.
A connection must be provided here or in the parent resource.
inline
Optional
- Type: string[]
This is a list of command strings.
They are executed in the order they are provided. This cannot be provided with script or scripts.
script
Optional
- Type: string
This is a path (relative or absolute) to a local script that will be copied to the remote resource and then executed.
This cannot be provided with inline or scripts.
scripts
Optional
- Type: string[]
This is a list of paths (relative or absolute) to local scripts that will be copied to the remote resource and then executed.
They are executed in the order they are provided. This cannot be provided with inline or script.
ResolveOptions
Options to the resolve() operation.
NOT the same as the ResolveContext; ResolveContext is exposed to Token implementors and resolution hooks, whereas this struct is just to bundle a number of things that would otherwise be arguments to resolve() in a readable way.
Initializer
Properties
Name | Type | Description |
---|---|---|
resolver | ITokenResolver | The resolver to apply to any resolvable tokens found. |
scope | constructs.IConstruct | The scope from which resolution is performed. |
preparing | boolean | Whether the resolution is being executed during the prepare phase or not. |
resolver
Required
- Type: ITokenResolver
The resolver to apply to any resolvable tokens found.
scope
Required
- Type: constructs.IConstruct
The scope from which resolution is performed.
preparing
Optional
- Type: boolean
- Default: false
Whether the resolution is being executed during the prepare phase or not.
S3BackendAssumeRoleConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
roleArn | string | (Required) Amazon Resource Name (ARN) of the IAM Role to assume. |
duration | string | (Optional) The duration individual credentials will be valid. |
externalId | string | (Optional) External identifier to use when assuming the role. |
policy | string | (Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed. |
policyArns | string[] | (Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed. |
sessionName | string | (Optional) Session name to use when assuming the role. |
sourceIdentity | string | (Optional) Source identity specified by the principal assuming the. |
tags | {[ key: string ]: string} | (Optional) Map of assume role session tags. |
transitiveTagKeys | string[] | (Optional) Set of assume role session tag keys to pass to any subsequent sessions. |
roleArn
Required
- Type: string
(Required) Amazon Resource Name (ARN) of the IAM Role to assume.
duration
Optional
- Type: string
(Optional) The duration individual credentials will be valid.
Credentials are automatically renewed up to the maximum defined by the AWS account. Specified using the format < hours >h< minutes >m< seconds >s with any unit being optional. For example, an hour and a half can be specified as 1h30m or 90m. Must be between 15 minutes (15m) and 12 hours (12h).
externalId
Optional
- Type: string
(Optional) External identifier to use when assuming the role.
policy
Optional
- Type: string
(Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
policyArns
Optional
- Type: string[]
(Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
sessionName
Optional
- Type: string
(Optional) Session name to use when assuming the role.
sourceIdentity
Optional
- Type: string
(Optional) Source identity specified by the principal assuming the.
tags
Optional
- Type: {[ key: string ]: string}
(Optional) Map of assume role session tags.
transitiveTagKeys
Optional
- Type: string[]
(Optional) Set of assume role session tag keys to pass to any subsequent sessions.
S3BackendAssumeRoleWithWebIdentityConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
duration | string | (Optional) The duration individual credentials will be valid. |
policy | string | (Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed. |
policyArns | string[] | (Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed. |
roleArn | string | (Required) Amazon Resource Name (ARN) of the IAM Role to assume. |
sessionName | string | (Optional) Session name to use when assuming the role. |
webIdentityToken | string | (Optional) The value of a web identity token from an OpenID Connect (OIDC) or OAuth provider. |
webIdentityTokenFile | string | (Optional) File containing a web identity token from an OpenID Connect (OIDC) or OAuth provider. |
duration
Optional
- Type: string
(Optional) The duration individual credentials will be valid.
Credentials are automatically renewed up to the maximum defined by the AWS account. Specified using the format < hours >h< minutes >m< seconds >s with any unit being optional. For example, an hour and a half can be specified as 1h30m or 90m. Must be between 15 minutes (15m) and 12 hours (12h).
policy
Optional
- Type: string
(Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
policyArns
Optional
- Type: string[]
(Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
roleArn
Optional
- Type: string
(Required) Amazon Resource Name (ARN) of the IAM Role to assume.
Can also be set with the AWS_ROLE_ARN environment variable.
sessionName
Optional
- Type: string
(Optional) Session name to use when assuming the role.
Can also be set with the AWS_ROLE_SESSION_NAME environment variable.
webIdentityToken
Optional
- Type: string
(Optional) The value of a web identity token from an OpenID Connect (OIDC) or OAuth provider.
One of web_identity_token or web_identity_token_file is required.
webIdentityTokenFile
Optional
- Type: string
(Optional) File containing a web identity token from an OpenID Connect (OIDC) or OAuth provider.
One of web_identity_token_file or web_identity_token is required. Can also be set with the AWS_WEB_IDENTITY_TOKEN_FILE environment variable.
S3BackendConfig
Stores the state as a given key in a given bucket on Amazon S3.
This backend also supports state locking and consistency checking via Dynamo DB, which can be enabled by setting the dynamodb_table field to an existing DynamoDB table name. A single DynamoDB table can be used to lock multiple remote state files. Terraform generates key names that include the values of the bucket and key variables.
Warning! It is highly recommended that you enable Bucket Versioning on the S3 bucket to allow for state recovery in the case of accidental deletions and human error.
Read more about this backend in the Terraform docs: https://developer.hashicorp.com/terraform/language/settings/backends/s3
Initializer
Properties
Name | Type | Description |
---|---|---|
bucket | string | Name of the S3 Bucket. |
key | string | Path to the state file inside the S3 Bucket. |
accessKey | string | (Optional) AWS access key. |
acl | string | (Optional) Canned ACL to be applied to the state file. |
allowedAccountIds | string | (Optional) List of allowed AWS account IDs to prevent potential destruction of a live environment. |
assumeRole | S3BackendAssumeRoleConfig | Assuming an IAM Role can be configured in two ways. |
assumeRolePolicy | string | (Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed. |
assumeRolePolicyArns | string[] | (Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed. |
assumeRoleTags | {[ key: string ]: string} | (Optional) Map of assume role session tags. |
assumeRoleTransitiveTagKeys | string[] | (Optional) Set of assume role session tag keys to pass to any subsequent sessions. |
assumeRoleWithWebIdentity | S3BackendAssumeRoleWithWebIdentityConfig | Assume Role With Web Identity Configuration. |
customCaBundle | string | (Optional) File containing custom root and intermediate certificates. |
dynamodbEndpoint | string | (Optional) Custom endpoint for the AWS DynamoDB API. |
dynamodbTable | string | (Optional) Name of DynamoDB Table to use for state locking and consistency. |
ec2MetadataServiceEndpoint | string | Optional) Custom endpoint URL for the EC2 Instance Metadata Service (IMDS) API. |
ec2MetadataServiceEndpointMode | string | (Optional) Mode to use in communicating with the metadata service. |
encrypt | boolean | (Optional) Enable server side encryption of the state file. |
endpoint | string | (Optional) Custom endpoint for the AWS S3 API. |
endpoints | S3BackendEndpointConfig | (Optional) The endpoint configuration block. |
externalId | string | (Optional) External identifier to use when assuming the role. |
forbiddenAccountIds | string | (Optional) List of forbidden AWS account IDs to prevent potential destruction of a live environment. |
forcePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
httpProxy | string | (Optional) URL of a proxy to use for HTTP requests when accessing the AWS API. |
httpsProxy | string | (Optional) URL of a proxy to use for HTTPS requests when accessing the AWS API. |
iamEndpoint | string | (Optional) Custom endpoint for the AWS Identity and Access Management (IAM) API. |
insecure | boolean | Optional) Whether to explicitly allow the backend to perform "insecure" SSL requests. |
kmsKeyId | string | (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. |
maxRetries | number | (Optional) The maximum number of times an AWS API request is retried on retryable failure. |
noProxy | string | (Optional) Comma-separated list of hosts that should not use HTTP or HTTPS proxies. |
profile | string | (Optional) Name of AWS profile in AWS shared credentials file (e.g. ~/.aws/credentials) or AWS shared configuration file (e.g. ~/.aws/config) to use for credentials and/or configuration. This can also be sourced from the AWS_PROFILE environment variable. |
region | string | AWS Region of the S3 Bucket and DynamoDB Table (if used). |
retryMode | string | (Optional) Specifies how retries are attempted. |
roleArn | string | (Optional) Amazon Resource Name (ARN) of the IAM Role to assume. |
secretKey | string | (Optional) AWS secret access key. |
sessionName | string | (Optional) Session name to use when assuming the role. |
sharedConfigFiles | string[] | (Optional) List of paths to AWS shared configuration files. |
sharedCredentialsFile | string | (Optional) Path to the AWS shared credentials file. |
sharedCredentialsFiles | string[] | (Optional) List of paths to AWS shared credentials files. |
skipCredentialsValidation | boolean | (Optional) Skip credentials validation via the STS API. |
skipMetadataApiCheck | boolean | (Optional) Skip usage of EC2 Metadata API. |
skipRegionValidation | boolean | (Optional) Skip validation of provided region name. |
skipRequestingAccountId | boolean | (Optional) Whether to skip requesting the account ID. |
skipS3Checksum | boolean | (Optional) Do not include checksum when uploading S3 Objects. |
sseCustomerKey | string | (Optional) The key to use for encrypting state with Server-Side Encryption with Customer-Provided Keys (SSE-C). |
stsEndpoint | string | (Optional) Custom endpoint for the AWS Security Token Service (STS) API. |
stsRegion | string | (Optional) AWS region for STS. |
token | string | (Optional) Multi-Factor Authentication (MFA) token. |
useLegacyWorkflow | boolean | (Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration. |
usePathStyle | boolean | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
workspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. |
bucket
Required
- Type: string
Name of the S3 Bucket.
key
Required
- Type: string
Path to the state file inside the S3 Bucket.
When using a non-default workspace, the state path will be /workspace_key_prefix/workspace_name/key
accessKey
Optional
- Type: string
(Optional) AWS access key.
If configured, must also configure secret_key. This can also be sourced from the AWS_ACCESS_KEY_ID environment variable, AWS shared credentials file (e.g. ~/.aws/credentials), or AWS shared configuration file (e.g. ~/.aws/config).
acl
Optional
- Type: string
(Optional) Canned ACL to be applied to the state file.
allowedAccountIds
Optional
- Type: string
(Optional) List of allowed AWS account IDs to prevent potential destruction of a live environment.
Conflicts with forbidden_account_ids.
assumeRole
Optional
Assuming an IAM Role can be configured in two ways.
The preferred way is to use the argument assume_role, the other, which is deprecated, is with arguments at the top level.
assumeRolePolicy
Optional
assumeRolePolicy
- Deprecated: Use assumeRole.policy instead.
- Type: string
(Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
assumeRolePolicyArns
Optional
assumeRolePolicyArns
- Deprecated: Use assumeRole.policyArns instead.
- Type: string[]
(Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
assumeRoleTags
Optional
assumeRoleTags
- Deprecated: Use assumeRole.tags instead.
- Type: {[ key: string ]: string}
(Optional) Map of assume role session tags.
assumeRoleTransitiveTagKeys
Optional
assumeRoleTransitiveTagKeys
- Deprecated: Use assumeRole.transitiveTagKeys instead.
- Type: string[]
(Optional) Set of assume role session tag keys to pass to any subsequent sessions.
assumeRoleWithWebIdentity
Optional
Assume Role With Web Identity Configuration.
customCaBundle
Optional
- Type: string
(Optional) File containing custom root and intermediate certificates.
Can also be set using the AWS_CA_BUNDLE environment variable. Setting ca_bundle in the shared config file is not supported.
dynamodbEndpoint
Optional
dynamodbEndpoint
- Deprecated: Use endpoints.dynamodb instead
- Type: string
(Optional) Custom endpoint for the AWS DynamoDB API.
This can also be sourced from the AWS_DYNAMODB_ENDPOINT environment variable.
dynamodbTable
Optional
- Type: string
(Optional) Name of DynamoDB Table to use for state locking and consistency.
The table must have a partition key named LockID with type of String. If not configured, state locking will be disabled.
ec2MetadataServiceEndpoint
Optional
- Type: string
Optional) Custom endpoint URL for the EC2 Instance Metadata Service (IMDS) API.
Can also be set with the AWS_EC2_METADATA_SERVICE_ENDPOINT environment variable.
ec2MetadataServiceEndpointMode
Optional
- Type: string
(Optional) Mode to use in communicating with the metadata service.
Valid values are IPv4 and IPv6. Can also be set with the AWS_EC2_METADATA_SERVICE_ENDPOINT_MODE environment variable.
encrypt
Optional
- Type: boolean
(Optional) Enable server side encryption of the state file.
endpoint
Optional
endpoint
- Deprecated: Use endpoints.s3 instead
- Type: string
(Optional) Custom endpoint for the AWS S3 API.
This can also be sourced from the AWS_S3_ENDPOINT environment variable.
endpoints
Optional
- Type: S3BackendEndpointConfig
(Optional) The endpoint configuration block.
externalId
Optional
externalId
- Deprecated: Use assume_role.external_id instead.
- Type: string
(Optional) External identifier to use when assuming the role.
forbiddenAccountIds
Optional
- Type: string
(Optional) List of forbidden AWS account IDs to prevent potential destruction of a live environment.
Conflicts with allowed_account_ids.
forcePathStyle
Optional
forcePathStyle
- Deprecated: Use usePathStyle instead
- Type: boolean
(Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >).
httpProxy
Optional
- Type: string
(Optional) URL of a proxy to use for HTTP requests when accessing the AWS API.
Can also be set using the HTTP_PROXY or http_proxy environment variables.
httpsProxy
Optional
- Type: string
(Optional) URL of a proxy to use for HTTPS requests when accessing the AWS API.
Can also be set using the HTTPS_PROXY or https_proxy environment variables.
iamEndpoint
Optional
iamEndpoint
- Deprecated: Use endpoints.iam instead
- Type: string
(Optional) Custom endpoint for the AWS Identity and Access Management (IAM) API.
This can also be sourced from the AWS_IAM_ENDPOINT environment variable.
insecure
Optional
- Type: boolean
Optional) Whether to explicitly allow the backend to perform "insecure" SSL requests.
If omitted, the default value is false.
kmsKeyId
Optional
- Type: string
(Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state.
Note that if this value is specified, Terraform will need kms:Encrypt, kms:Decrypt and kms:GenerateDataKey permissions on this KMS key.
maxRetries
Optional
- Type: number
(Optional) The maximum number of times an AWS API request is retried on retryable failure.
Defaults to 5.
noProxy
Optional
- Type: string
(Optional) Comma-separated list of hosts that should not use HTTP or HTTPS proxies.
Each value can be one of:
- A domain name
- An IP address
- A CIDR address
- An asterisk (*), to indicate that no proxying should be performed Domain name and IP address values can also include a port number. Can also be set using the NO_PROXY or no_proxy environment variables.
profile
Optional
- Type: string
(Optional) Name of AWS profile in AWS shared credentials file (e.g. ~/.aws/credentials) or AWS shared configuration file (e.g. ~/.aws/config) to use for credentials and/or configuration. This can also be sourced from the AWS_PROFILE environment variable.
region
Optional
- Type: string
AWS Region of the S3 Bucket and DynamoDB Table (if used).
This can also be sourced from the AWS_DEFAULT_REGION and AWS_REGION environment variables.
retryMode
Optional
- Type: string
(Optional) Specifies how retries are attempted.
Valid values are standard and adaptive. Can also be configured using the AWS_RETRY_MODE environment variable or the shared config file parameter retry_mode.
roleArn
Optional
roleArn
- Deprecated: Use assumeRole.roleArn instead.
- Type: string
(Optional) Amazon Resource Name (ARN) of the IAM Role to assume.
secretKey
Optional
- Type: string
(Optional) AWS secret access key.
If configured, must also configure access_key. This can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, AWS shared credentials file (e.g. ~/.aws/credentials), or AWS shared configuration file (e.g. ~/.aws/config)
sessionName
Optional
sessionName
- Deprecated: Use assumeRole.sessionName instead.
- Type: string
(Optional) Session name to use when assuming the role.
sharedConfigFiles
Optional
- Type: string[]
(Optional) List of paths to AWS shared configuration files.
Defaults to ~/.aws/config.
sharedCredentialsFile
Optional
- Type: string
(Optional) Path to the AWS shared credentials file.
Defaults to ~/.aws/credentials.
sharedCredentialsFiles
Optional
- Type: string[]
(Optional) List of paths to AWS shared credentials files.
Defaults to ~/.aws/credentials.
skipCredentialsValidation
Optional
- Type: boolean
(Optional) Skip credentials validation via the STS API.
skipMetadataApiCheck
Optional
- Type: boolean
(Optional) Skip usage of EC2 Metadata API.
skipRegionValidation
Optional
- Type: boolean
(Optional) Skip validation of provided region name.
skipRequestingAccountId
Optional
- Type: boolean
(Optional) Whether to skip requesting the account ID.
Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
skipS3Checksum
Optional
- Type: boolean
(Optional) Do not include checksum when uploading S3 Objects.
Useful for some S3-Compatible APIs.
sseCustomerKey
Optional
- Type: string
(Optional) The key to use for encrypting state with Server-Side Encryption with Customer-Provided Keys (SSE-C).
This is the base64-encoded value of the key, which must decode to 256 bits. This can also be sourced from the AWS_SSE_CUSTOMER_KEY environment variable, which is recommended due to the sensitivity of the value. Setting it inside a terraform file will cause it to be persisted to disk in terraform.tfstate.
stsEndpoint
Optional
stsEndpoint
- Deprecated: Use endpoints.sts instead
- Type: string
(Optional) Custom endpoint for the AWS Security Token Service (STS) API.
This can also be sourced from the AWS_STS_ENDPOINT environment variable.
stsRegion
Optional
- Type: string
(Optional) AWS region for STS.
If unset, AWS will use the same region for STS as other non-STS operations.
token
Optional
- Type: string
(Optional) Multi-Factor Authentication (MFA) token.
This can also be sourced from the AWS_SESSION_TOKEN environment variable.
useLegacyWorkflow
Optional
- Type: boolean
(Optional) Use the legacy authentication workflow, preferring environment variables over backend configuration.
Defaults to true. This behavior does not align with the authentication flow of the AWS CLI or SDK's, and will be removed in the future.
usePathStyle
Optional
- Type: boolean
(Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >).
workspaceKeyPrefix
Optional
- Type: string
(Optional) Prefix applied to the state path inside the bucket.
This is only relevant when using a non-default workspace. Defaults to env:
S3BackendEndpointConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
dynamodb | string | (Optional) Custom endpoint URL for the AWS DynamoDB API. |
iam | string | (Optional) Custom endpoint URL for the AWS IAM API. |
s3 | string | (Optional) Custom endpoint URL for the AWS S3 API. |
sso | string | (Optional) Custom endpoint URL for the AWS IAM Identity Center (formerly known as AWS SSO) API. |
sts | string | (Optional) Custom endpoint URL for the AWS STS API. |
dynamodb
Optional
- Type: string
(Optional) Custom endpoint URL for the AWS DynamoDB API.
This can also be sourced from the environment variable AWS_ENDPOINT_URL_DYNAMODB or the deprecated environment variable AWS_DYNAMODB_ENDPOINT.
iam
Optional
- Type: string
(Optional) Custom endpoint URL for the AWS IAM API.
This can also be sourced from the environment variable AWS_ENDPOINT_URL_IAM or the deprecated environment variable AWS_IAM_ENDPOINT.
s3
Optional
- Type: string
(Optional) Custom endpoint URL for the AWS S3 API.
This can also be sourced from the environment variable AWS_ENDPOINT_URL_S3 or the deprecated environment variable AWS_S3_ENDPOINT.
sso
Optional
- Type: string
(Optional) Custom endpoint URL for the AWS IAM Identity Center (formerly known as AWS SSO) API.
This can also be sourced from the environment variable AWS_ENDPOINT_URL_SSO.
sts
Optional
- Type: string
(Optional) Custom endpoint URL for the AWS STS API.
This can also be sourced from the environment variable AWS_ENDPOINT_URL_STS or the deprecated environment variable AWS_STS_ENDPOINT.
SSHProvisionerConnection
Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.
Refer to {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/connection connection}
Initializer
Properties
Name | Type | Description |
---|---|---|
host | string | The address of the resource to connect to. |
type | string | The connection type. |
agent | string | Set to false to disable using ssh-agent to authenticate. |
agentIdentity | string | The preferred identity from the ssh agent for authentication. |
bastionCertificate | string | The contents of a signed CA Certificate. |
bastionHost | string | Setting this enables the bastion Host connection. |
bastionHostKey | string | The public key from the remote host or the signing CA, used to verify the host connection. |
bastionPassword | string | The password to use for the bastion host. |
bastionPort | number | The port to use connect to the bastion host. |
bastionPrivateKey | string | The contents of an SSH key file to use for the bastion host. |
bastionUser | string | The user for the connection to the bastion host. |
certificate | string | The contents of a signed CA Certificate. |
hostKey | string | The public key from the remote host or the signing CA, used to verify the connection. |
password | string | The password to use for the connection. |
port | number | The port to connect to. |
privateKey | string | The contents of an SSH key to use for the connection. |
proxyHost | string | Setting this enables the SSH over HTTP connection. |
proxyPort | number | The port to use connect to the proxy host. |
proxyScheme | string | The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy. |
proxyUserName | string | The username to use connect to the private proxy host. |
proxyUserPassword | string | The password to use connect to the private proxy host. |
scriptPath | string | The path used to copy scripts meant for remote execution. |
targetPlatform | string | The target platform to connect to. |
timeout | string | The timeout to wait for the connection to become available. |
user | string | The user to use for the connection. |
host
Required
- Type: string
The address of the resource to connect to.
type
Required
- Type: string
The connection type.
Valid values are "ssh" and "winrm". Provisioners typically assume that the remote system runs Microsoft Windows when using WinRM. Behaviors based on the SSH target_platform will force Windows-specific behavior for WinRM, unless otherwise specified.
agent
Optional
- Type: string
Set to false to disable using ssh-agent to authenticate.
On Windows the only supported SSH authentication agent is Pageant.
agentIdentity
Optional
- Type: string
The preferred identity from the ssh agent for authentication.
bastionCertificate
Optional
- Type: string
The contents of a signed CA Certificate.
The certificate argument must be used in conjunction with a bastion_private_key. These can be loaded from a file on disk using the the file function.
bastionHost
Optional
- Type: string
Setting this enables the bastion Host connection.
The provisioner will connect to bastion_host first, and then connect from there to host.
bastionHostKey
Optional
- Type: string
The public key from the remote host or the signing CA, used to verify the host connection.
bastionPassword
Optional
- Type: string
The password to use for the bastion host.
bastionPort
Optional
- Type: number
The port to use connect to the bastion host.
bastionPrivateKey
Optional
- Type: string
The contents of an SSH key file to use for the bastion host.
These can be loaded from a file on disk using the file function.
bastionUser
Optional
- Type: string
The user for the connection to the bastion host.
certificate
Optional
- Type: string
The contents of a signed CA Certificate.
The certificate argument must be used in conjunction with a private_key. These can be loaded from a file on disk using the the file function.
hostKey
Optional
- Type: string
The public key from the remote host or the signing CA, used to verify the connection.
password
Optional
- Type: string
The password to use for the connection.
port
Optional
- Type: number
- Default: 22
The port to connect to.
privateKey
Optional
- Type: string
The contents of an SSH key to use for the connection.
These can be loaded from a file on disk using the file function. This takes preference over password if provided.
proxyHost
Optional
- Type: string
Setting this enables the SSH over HTTP connection.
This host will be connected to first, and then the host or bastion_host connection will be made from there.
proxyPort
Optional
- Type: number
The port to use connect to the proxy host.
proxyScheme
Optional
- Type: string
The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy.
proxyUserName
Optional
- Type: string
The username to use connect to the private proxy host.
This argument should be specified only if authentication is required for the HTTP Proxy server.
proxyUserPassword
Optional
- Type: string
The password to use connect to the private proxy host.
This argument should be specified only if authentication is required for the HTTP Proxy server.
scriptPath
Optional
- Type: string
The path used to copy scripts meant for remote execution.
Refer to {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/connection#how-provisioners-execute-remote-scripts How Provisioners Execute Remote Scripts below for more details}
targetPlatform
Optional
- Type: string
- Default: unix
The target platform to connect to.
Valid values are "windows" and "unix". If the platform is set to windows, the default scriptpath is c:\windows\temp\terraform%RAND%.cmd, assuming the SSH default shell is cmd.exe. If the SSH default shell is PowerShell, set scriptpath to "c:/windows/temp/terraform%RAND%.ps1"
timeout
Optional
- Type: string
- Default: 5m
The timeout to wait for the connection to become available.
Should be provided as a string (e.g., "30s" or "5m".)
user
Optional
- Type: string
- Default: root
The user to use for the connection.
StackAnnotation
Initializer
Properties
Name | Type | Description |
---|---|---|
constructPath | string | No description. |
level | AnnotationMetadataEntryType | No description. |
message | string | No description. |
stacktrace | string[] | No description. |
constructPath
Required
- Type: string
level
Required
message
Required
- Type: string
stacktrace
Optional
- Type: string[]
StackManifest
Initializer
Properties
Name | Type | Description |
---|---|---|
annotations | StackAnnotation[] | No description. |
constructPath | string | No description. |
dependencies | string[] | No description. |
name | string | No description. |
stackMetadataPath | string | No description. |
synthesizedStackPath | string | No description. |
workingDirectory | string | No description. |
annotations
Required
- Type: StackAnnotation[]
constructPath
Required
- Type: string
dependencies
Required
- Type: string[]
name
Required
- Type: string
stackMetadataPath
Required
- Type: string
synthesizedStackPath
Required
- Type: string
workingDirectory
Required
- Type: string
SwiftBackendConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
container | string | No description. |
applicationCredentialId | string | No description. |
applicationCredentialName | string | No description. |
applicationCredentialSecret | string | No description. |
archiveContainer | string | No description. |
authUrl | string | No description. |
cacertFile | string | No description. |
cert | string | No description. |
cloud | string | No description. |
defaultDomain | string | No description. |
domainId | string | No description. |
domainName | string | No description. |
expireAfter | string | No description. |
insecure | boolean | No description. |
key | string | No description. |
password | string | No description. |
projectDomainId | string | No description. |
projectDomainName | string | No description. |
regionName | string | No description. |
stateName | string | No description. |
tenantId | string | No description. |
tenantName | string | No description. |
token | string | No description. |
userDomainId | string | No description. |
userDomainName | string | No description. |
userId | string | No description. |
userName | string | No description. |
container
Required
container
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
applicationCredentialId
Optional
applicationCredentialId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
applicationCredentialName
Optional
applicationCredentialName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
applicationCredentialSecret
Optional
applicationCredentialSecret
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
archiveContainer
Optional
archiveContainer
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
authUrl
Optional
authUrl
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
cacertFile
Optional
cacertFile
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
cert
Optional
cert
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
cloud
Optional
cloud
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
defaultDomain
Optional
defaultDomain
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
domainId
Optional
domainId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
domainName
Optional
domainName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
expireAfter
Optional
expireAfter
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
insecure
Optional
insecure
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: boolean
key
Optional
key
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
password
Optional
password
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
projectDomainId
Optional
projectDomainId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
projectDomainName
Optional
projectDomainName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
regionName
Optional
regionName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
stateName
Optional
stateName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
tenantId
Optional
tenantId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
tenantName
Optional
tenantName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
token
Optional
token
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userDomainId
Optional
userDomainId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userDomainName
Optional
userDomainName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userId
Optional
userId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
userName
Optional
userName
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
- Type: string
TerraformAssetConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
path | string | No description. |
assetHash | string | No description. |
type | AssetType | No description. |
path
Required
- Type: string
assetHash
Optional
- Type: string
type
Optional
- Type: AssetType
TerraformCondition
Initializer
Properties
Name | Type | Description |
---|---|---|
condition | any | This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not. |
errorMessage | string | This contains the text that Terraform will include as part of error messages when it detects an unmet condition. |
condition
Required
- Type: any
This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not.
errorMessage
Required
- Type: string
This contains the text that Terraform will include as part of error messages when it detects an unmet condition.
TerraformConstructor
Initializer
Properties
Name | Type | Description |
---|---|---|
tfResourceType | string | No description. |
tfResourceType
Required
- Type: string
TerraformElementMetadata
Initializer
Properties
Name | Type | Description |
---|---|---|
path | string | No description. |
stackTrace | string[] | No description. |
uniqueId | string | No description. |
path
Required
- Type: string
stackTrace
Required
- Type: string[]
uniqueId
Required
- Type: string
TerraformHclModuleConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
dependsOn | ITerraformDependable[] | No description. |
forEach | ITerraformIterator | No description. |
providers | TerraformProvider | TerraformModuleProvider[] | No description. |
skipAssetCreationFromLocalModules | boolean | No description. |
source | string | No description. |
version | string | No description. |
variables | {[ key: string ]: any} | No description. |
dependsOn
Optional
- Type: ITerraformDependable[]
forEach
Optional
- Type: ITerraformIterator
providers
Optional
- Type: TerraformProvider | TerraformModuleProvider[]
skipAssetCreationFromLocalModules
Optional
- Type: boolean
source
Required
- Type: string
version
Optional
- Type: string
variables
Optional
- Type: {[ key: string ]: any}
TerraformMetaArguments
Initializer
Properties
Name | Type | Description |
---|---|---|
connection | SSHProvisionerConnection | WinrmProvisionerConnection | No description. |
count | number | TerraformCount | No description. |
dependsOn | ITerraformDependable[] | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
provisioners | FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[] | No description. |
connection
Optional
count
Optional
- Type: number | TerraformCount
dependsOn
Optional
- Type: ITerraformDependable[]
forEach
Optional
- Type: ITerraformIterator
lifecycle
Optional
provider
Optional
- Type: TerraformProvider
provisioners
Optional
- Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]
TerraformModuleConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
dependsOn | ITerraformDependable[] | No description. |
forEach | ITerraformIterator | No description. |
providers | TerraformProvider | TerraformModuleProvider[] | No description. |
skipAssetCreationFromLocalModules | boolean | No description. |
source | string | No description. |
version | string | No description. |
dependsOn
Optional
- Type: ITerraformDependable[]
forEach
Optional
- Type: ITerraformIterator
providers
Optional
- Type: TerraformProvider | TerraformModuleProvider[]
skipAssetCreationFromLocalModules
Optional
- Type: boolean
source
Required
- Type: string
version
Optional
- Type: string
TerraformModuleProvider
Initializer
Properties
Name | Type | Description |
---|---|---|
moduleAlias | string | No description. |
provider | TerraformProvider | No description. |
moduleAlias
Required
- Type: string
provider
Required
- Type: TerraformProvider
TerraformModuleUserConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
dependsOn | ITerraformDependable[] | No description. |
forEach | ITerraformIterator | No description. |
providers | TerraformProvider | TerraformModuleProvider[] | No description. |
skipAssetCreationFromLocalModules | boolean | No description. |
dependsOn
Optional
- Type: ITerraformDependable[]
forEach
Optional
- Type: ITerraformIterator
providers
Optional
- Type: TerraformProvider | TerraformModuleProvider[]
skipAssetCreationFromLocalModules
Optional
- Type: boolean
TerraformOutputConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
value | any | No description. |
dependsOn | ITerraformDependable[] | No description. |
description | string | No description. |
precondition | Precondition | No description. |
sensitive | boolean | No description. |
staticId | boolean | If set to true the synthesized Terraform Output will be named after the id passed to the constructor instead of the default (TerraformOutput.friendlyUniqueId). |
value
Required
- Type: any
dependsOn
Optional
- Type: ITerraformDependable[]
description
Optional
- Type: string
precondition
Optional
- Type: Precondition
sensitive
Optional
- Type: boolean
staticId
Optional
- Type: boolean
- Default: false
If set to true the synthesized Terraform Output will be named after the id
passed to the constructor instead of the default (TerraformOutput.friendlyUniqueId).
TerraformProviderConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
terraformResourceType | string | No description. |
terraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
terraformProviderSource | string | No description. |
terraformResourceType
Required
- Type: string
terraformGeneratorMetadata
Optional
terraformProviderSource
Optional
- Type: string
TerraformProviderGeneratorMetadata
Initializer
Properties
Name | Type | Description |
---|---|---|
providerName | string | No description. |
providerVersion | string | No description. |
providerVersionConstraint | string | No description. |
providerName
Required
- Type: string
providerVersion
Optional
- Type: string
providerVersionConstraint
Optional
- Type: string
TerraformResourceConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
connection | SSHProvisionerConnection | WinrmProvisionerConnection | No description. |
count | number | TerraformCount | No description. |
dependsOn | ITerraformDependable[] | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
provisioners | FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[] | No description. |
terraformResourceType | string | No description. |
terraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
connection
Optional
count
Optional
- Type: number | TerraformCount
dependsOn
Optional
- Type: ITerraformDependable[]
forEach
Optional
- Type: ITerraformIterator
lifecycle
Optional
provider
Optional
- Type: TerraformProvider
provisioners
Optional
- Type: FileProvisioner | LocalExecProvisioner | RemoteExecProvisioner[]
terraformResourceType
Required
- Type: string
terraformGeneratorMetadata
Optional
TerraformResourceImport
Initializer
Properties
Name | Type | Description |
---|---|---|
id | string | No description. |
provider | TerraformProvider | No description. |
id
Required
- Type: string
provider
Optional
- Type: TerraformProvider
TerraformResourceLifecycle
Initializer
Properties
Name | Type | Description |
---|---|---|
createBeforeDestroy | boolean | No description. |
ignoreChanges | string[] | string | No description. |
postcondition | Postcondition[] | No description. |
precondition | Precondition[] | No description. |
preventDestroy | boolean | No description. |
replaceTriggeredBy | string | ITerraformDependable[] | No description. |
createBeforeDestroy
Optional
- Type: boolean
ignoreChanges
Optional
- Type: string[] | string
postcondition
Optional
- Type: Postcondition[]
precondition
Optional
- Type: Precondition[]
preventDestroy
Optional
- Type: boolean
replaceTriggeredBy
Optional
- Type: string | ITerraformDependable[]
TerraformResourceMoveById
Initializer
Properties
from
Required
- Type: string
to
Required
- Type: string
TerraformResourceMoveByTarget
Initializer
Properties
Name | Type | Description |
---|---|---|
moveTarget | string | No description. |
index | string | number | No description. |
moveTarget
Required
- Type: string
index
Optional
- Type: string | number
TerraformStackMetadata
Initializer
Properties
Name | Type | Description |
---|---|---|
backend | string | No description. |
stackName | string | No description. |
version | string | No description. |
cloud | string | No description. |
backend
Required
- Type: string
stackName
Required
- Type: string
version
Required
- Type: string
cloud
Optional
- Type: string
TerraformVariableConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
default | any | No description. |
description | string | No description. |
nullable | boolean | No description. |
sensitive | boolean | No description. |
type | string | The type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable. |
validation | TerraformVariableValidationConfig[] | Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block. |
default
Optional
- Type: any
description
Optional
- Type: string
nullable
Optional
- Type: boolean
sensitive
Optional
- Type: boolean
type
Optional
- Type: string
The type argument in a variable block allows you to restrict the type of value that will be accepted as the value for a variable.
If no type constraint is set then a value of any type is accepted.
While type constraints are optional, we recommend specifying them; they serve as easy reminders for users of the module, and allow Terraform to return a helpful error message if the wrong type is used.
Type constraints are created from a mixture of type keywords and type constructors. The supported type keywords are:
- string
- number
- bool
The type constructors allow you to specify complex types such as collections:
- list(\< TYPE\ >)
- set(\< TYPE\ >)
- map(\< TYPE\ >)
- object({\< ATTR NAME\ > = \< TYPE\ >, ... })
- tuple([\< TYPE\ >, ...])
The keyword any may be used to indicate that any type is acceptable. For more information on the meaning and behavior of these different types, as well as detailed information about automatic conversion of complex types, refer to {@link https://developer.hashicorp.com/terraform/language/expressions/type-constraints Type Constraints}.
If both the type and default arguments are specified, the given default value must be convertible to the specified type.
validation
Optional
Specify arbitrary custom validation rules for a particular variable using a validation block nested within the corresponding variable block.
TerraformVariableValidationConfig
Add one or more validation blocks within the variable block to specify custom conditions.
Initializer
Properties
Name | Type | Description |
---|---|---|
condition | any | This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not. |
errorMessage | string | This contains the text that Terraform will include as part of error messages when it detects an unmet condition. |
condition
Required
- Type: any
This is a boolean expression that should return true if the intended assumption or guarantee is fulfilled or false if it does not.
errorMessage
Required
- Type: string
This contains the text that Terraform will include as part of error messages when it detects an unmet condition.
TestingAppConfig
Initializer
Properties
Name | Type | Description |
---|---|---|
context | {[ key: string ]: any} | No description. |
enableFutureFlags | boolean | No description. |
fakeCdktfJsonPath | boolean | No description. |
outdir | string | No description. |
stackTraces | boolean | No description. |
stubVersion | boolean | No description. |
context
Optional
- Type: {[ key: string ]: any}
enableFutureFlags
Optional
- Type: boolean
fakeCdktfJsonPath
Optional
- Type: boolean
outdir
Optional
- Type: string
stackTraces
Optional
- Type: boolean
stubVersion
Optional
- Type: boolean
WinrmProvisionerConnection
Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.
See {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/connection connection}
Initializer
Properties
Name | Type | Description |
---|---|---|
host | string | The address of the resource to connect to. |
type | string | The connection type. |
cacert | string | The CA certificate to validate against. |
https | boolean | Set to true to connect using HTTPS instead of HTTP. |
insecure | boolean | Set to true to skip validating the HTTPS certificate chain. |
password | string | The password to use for the connection. |
port | number | The port to connect to. |
scriptPath | string | The path used to copy scripts meant for remote execution. |
timeout | string | The timeout to wait for the connection to become available. |
useNtlm | boolean | Set to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. |
user | string | The user to use for the connection. |
host
Required
- Type: string
The address of the resource to connect to.
type
Required
- Type: string
The connection type.
Valid values are "ssh" and "winrm". Provisioners typically assume that the remote system runs Microsoft Windows when using WinRM. Behaviors based on the SSH target_platform will force Windows-specific behavior for WinRM, unless otherwise specified.
cacert
Optional
- Type: string
The CA certificate to validate against.
https
Optional
- Type: boolean
Set to true to connect using HTTPS instead of HTTP.
insecure
Optional
- Type: boolean
Set to true to skip validating the HTTPS certificate chain.
password
Optional
- Type: string
The password to use for the connection.
port
Optional
- Type: number
- Default: 22
The port to connect to.
scriptPath
Optional
- Type: string
The path used to copy scripts meant for remote execution.
Refer to {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/connection#how-provisioners-execute-remote-scripts How Provisioners Execute Remote Scripts below for more details}
timeout
Optional
- Type: string
- Default: 5m
The timeout to wait for the connection to become available.
Should be provided as a string (e.g., "30s" or "5m".)
useNtlm
Optional
- Type: boolean
Set to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest.
Refer to Authentication for Remote Connections in the Windows App Development documentation for more details.
user
Optional
- Type: string
- Default: root
The user to use for the connection.
Classes
Annotations
Includes API for attaching annotations such as warning messages to constructs.
Methods
Name | Description |
---|---|
addError | Adds an { "error": < message > } metadata entry to this construct. |
addInfo | Adds an info metadata entry to this construct. |
addWarning | Adds a warning metadata entry to this construct. |
addError
Adds an { "error": < message > } metadata entry to this construct.
The toolkit will fail synthesis when errors are reported.
message
Required
- Type: string
The error message.
addInfo
Adds an info metadata entry to this construct.
The CLI will display the info message when apps are synthesized.
message
Required
- Type: string
The info message.
addWarning
Adds a warning metadata entry to this construct.
The CLI will display the warning when an app is synthesized. In a future release the CLI might introduce a --strict flag which will then fail the synthesis if it encounters a warning.
message
Required
- Type: string
The warning message.
Static Functions
Name | Description |
---|---|
of | Returns the annotations API for a construct scope. |
of
Returns the annotations API for a construct scope.
scope
Required
- Type: constructs.IConstruct
The scope.
AnyListList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
allWithMapKey | Creating an iterator for this complex list. |
computeFqn | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
allWithMapKey
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
mapKeyAttributeName
Required
- Type: string
computeFqn
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
AnyListMap
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
key
Required
- Type: string
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
AnyMap
- Implements: ITerraformAddressable, IResolvable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
lookup | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
lookup
key
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
AnyMapList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
Aspects
Aspects can be applied to CDK tree scopes and can operate on the tree before synthesis.
Methods
Name | Description |
---|---|
add | Adds an aspect to apply this scope before synthesis. |
add
Adds an aspect to apply this scope before synthesis.
aspect
Required
- Type: IAspect
The aspect to add.
Static Functions
Name | Description |
---|---|
of | Returns the Aspects object associated with a construct scope. |
of
Returns the Aspects
object associated with a construct scope.
scope
Required
- Type: constructs.IConstruct
The scope for which these aspects will apply.
Properties
all
Required
- Type: IAspect[]
The list of aspects which were directly applied on this scope.
AssertionReturn
Class representing the contents of a return by an assertion.
Initializers
Name | Type | Description |
---|---|---|
message | string | - String message containing information about the result of the assertion. |
pass | boolean | - Boolean pass denoting the success of the assertion. |
message
Required
- Type: string
String message containing information about the result of the assertion.
pass
Required
- Type: boolean
Boolean pass denoting the success of the assertion.
Properties
Name | Type | Description |
---|---|---|
message | string | - String message containing information about the result of the assertion. |
pass | boolean | - Boolean pass denoting the success of the assertion. |
message
Required
- Type: string
String message containing information about the result of the assertion.
pass
Required
- Type: boolean
Boolean pass denoting the success of the assertion.
BooleanList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
allWithMapKey | Creating an iterator for this complex list. |
computeFqn | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
allWithMapKey
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
mapKeyAttributeName
Required
- Type: string
computeFqn
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
BooleanListList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
allWithMapKey | Creating an iterator for this complex list. |
computeFqn | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
allWithMapKey
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
mapKeyAttributeName
Required
- Type: string
computeFqn
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
BooleanListMap
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
key
Required
- Type: string
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
BooleanMap
- Implements: ITerraformAddressable, IResolvable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
lookup | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
lookup
key
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
BooleanMapList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
CloudWorkspace
A cloud workspace can either be a single named workspace, or a list of tagged workspaces.
Initializers
Name | Type | Description |
---|
Methods
Name | Description |
---|---|
toTerraform | No description. |
toTerraform
ComplexComputedList
- Implements: IInterpolatingParent, IResolvable, ITerraformAddressable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
complexComputedListIndex | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
complexComputedListIndex
Required
- Type: string
wrapsSet
Optional
- Type: boolean
Methods
Name | Description |
---|---|
computeFqn | No description. |
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. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
computeFqn
getAnyMapAttribute
getAnyMapAttribute
terraformAttribute
Required
- Type: string
getBooleanAttribute
getBooleanAttribute
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
getBooleanMapAttribute
terraformAttribute
Required
- Type: string
getListAttribute
getListAttribute
terraformAttribute
Required
- Type: string
getNumberAttribute
getNumberAttribute
terraformAttribute
Required
- Type: string
getNumberListAttribute
getNumberListAttribute
terraformAttribute
Required
- Type: string
getNumberMapAttribute
getNumberMapAttribute
terraformAttribute
Required
- Type: string
getStringAttribute
getStringAttribute
terraformAttribute
Required
- Type: string
getStringMapAttribute
getStringMapAttribute
terraformAttribute
Required
- Type: string
interpolationForAttribute
interpolationForAttribute
property
Required
- Type: string
resolve
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
creationStack
- Deprecated: Going to be replaced by Array of ComplexListItem and will be removed in the future
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
fqn
- Deprecated: Going to be replaced by Array of ComplexListItem and will be removed in the future
- Type: string
ComplexList
- Implements: ITerraformAddressable, IResolvable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
allWithMapKey | Creating an iterator for this complex list. |
computeFqn | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
allWithMapKey
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
mapKeyAttributeName
Required
- Type: string
computeFqn
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
ComplexMap
- Implements: ITerraformAddressable, IResolvable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
ComplexObject
- Implements: IInterpolatingParent, IResolvable, ITerraformAddressable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
complexObjectIsFromSet | boolean | set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items. |
complexObjectIndex | string | number | the index of the complex object in a list. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
complexObjectIsFromSet
Required
- Type: boolean
set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
complexObjectIndex
Optional
- Type: string | number
the index of the complex object in a list.
Methods
Name | Description |
---|---|
computeFqn | No description. |
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. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
getAnyMapAttribute
terraformAttribute
Required
- Type: string
getBooleanAttribute
terraformAttribute
Required
- Type: string
getBooleanMapAttribute
terraformAttribute
Required
- Type: string
getListAttribute
terraformAttribute
Required
- Type: string
getNumberAttribute
terraformAttribute
Required
- Type: string
getNumberListAttribute
terraformAttribute
Required
- Type: string
getNumberMapAttribute
terraformAttribute
Required
- Type: string
getStringAttribute
terraformAttribute
Required
- Type: string
getStringMapAttribute
terraformAttribute
Required
- Type: string
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
DefaultTokenResolver
- Implements: ITokenResolver
Default resolver implementation.
Initializers
Name | Type | Description |
---|---|---|
concat | IFragmentConcatenator | No description. |
concat
Required
- Type: IFragmentConcatenator
Methods
Name | Description |
---|---|
resolveList | Resolves a list of string. |
resolveMap | Resolves a map token. |
resolveNumberList | Resolves a list of numbers. |
resolveString | Resolve string fragments to Tokens. |
resolveToken | Default Token resolution. |
resolveList
Resolves a list of string.
xs
Required
- Type: string[]
context
Required
- Type: IResolveContext
resolveMap
Resolves a map token.
xs
Required
- Type: {[ key: string ]: any}
context
Required
- Type: IResolveContext
resolveNumberList
Resolves a list of numbers.
xs
Required
- Type: number[]
context
Required
- Type: IResolveContext
resolveString
Resolve string fragments to Tokens.
fragments
Required
- Type: TokenizedStringFragments
context
Required
- Type: IResolveContext
resolveToken
Default Token resolution.
Resolve the Token, recurse into whatever it returns, then finally post-process it.
t
Required
- Type: IResolvable
context
Required
- Type: IResolveContext
postProcessor
Required
- Type: IPostProcessor
DynamicListTerraformIterator
Initializers
Name | Type | Description |
---|---|---|
list | string[] | IResolvable | number[] | boolean | IResolvable[] | No description. |
mapKeyAttributeName | string | No description. |
list
Required
- Type: string[] | IResolvable | number[] | boolean | IResolvable[]
mapKeyAttributeName
Required
- Type: string
Methods
Name | Description |
---|---|
dynamic | Creates a dynamic expression that can be used to loop over this iterator in a dynamic block. |
forExpressionForList | Creates a for expression that results in a list. |
forExpressionForMap | Creates a for expression that results in a map. |
getAny | No description. |
getAnyMap | No description. |
getBoolean | No description. |
getBooleanMap | No description. |
getList | No description. |
getMap | No description. |
getNumber | No description. |
getNumberList | No description. |
getNumberMap | No description. |
getString | No description. |
getStringMap | No description. |
keys | Creates a for expression that maps the iterators to its keys. |
pluckProperty | Creates a for expression that accesses the key on each element of the iterator. |
values | Creates a for expression that maps the iterators to its value in case it is a map. |
dynamic
Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
See https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-for-list-attributes
attributes
Required
- Type: {[ key: string ]: any}
forExpressionForList
Creates a for expression that results in a list.
This method allows you to create every possible for expression, but requires more knowledge about Terraform's for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true")
will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ]
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
expression
Required
- Type: string | IResolvable
The expression to use in the for mapping.
forExpressionForMap
Creates a for expression that results in a map.
This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true")
will result in { for key, val in var.myIteratorSource: key = > val.foo if val.bar == true }
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
keyExpression
Required
- Type: string | IResolvable
The expression to use as key in the for mapping.
valueExpression
Required
- Type: string | IResolvable
The expression to use as value in the for mapping.
getAny
attribute
Required
- Type: string
name of the property to retrieve.
getAnyMap
attribute
Required
- Type: string
name of the property to retrieve.
getBoolean
attribute
Required
- Type: string
name of the property to retrieve.
getBooleanMap
attribute
Required
- Type: string
name of the property to retrieve.
getList
attribute
Required
- Type: string
name of the property to retrieve.
getMap
attribute
Required
- Type: string
name of the property to retrieve.
getNumber
attribute
Required
- Type: string
name of the property to retrieve.
getNumberList
attribute
Required
- Type: string
name of the property to retrieve.
getNumberMap
attribute
Required
- Type: string
name of the property to retrieve.
getString
attribute
Required
- Type: string
name of the property to retrieve.
getStringMap
attribute
Required
- Type: string
name of the property to retrieve.
keys
Creates a for expression that maps the iterators to its keys.
For lists these would be the indices, for maps the keys.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
pluckProperty
Creates a for expression that accesses the key on each element of the iterator.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
property
Required
- Type: string
The property of the iterators values to map to.
values
Creates a for expression that maps the iterators to its value in case it is a map.
For lists these would stay the same.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
Static Functions
Name | Description |
---|---|
fromComplexList | Creates a new iterator from a complex list. |
fromDataSources | Creates a new iterator from a data source that has been created with the for_each argument. |
fromList | Creates a new iterator from a list. |
fromMap | Creates a new iterator from a map. |
fromResources | Creates a new iterator from a resource that has been created with the for_each argument. |
fromComplexList
Creates a new iterator from a complex list.
One example for this would be a list of maps. The list will be converted into a map with the mapKeyAttributeName as the key.
Example
list
Required
- Type: IResolvable | ComplexList | StringMapList | NumberMapList | BooleanMapList | AnyMapList
the list to iterate over.
mapKeyAttributeName
Required
- Type: string
the name of the attribute that should be used as the key in the map.
Visit https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-on-complex-lists for more information.
fromDataSources
Creates a new iterator from a data source that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
fromList
Creates a new iterator from a list.
list
Required
- Type: string[] | IResolvable | number[] | boolean | IResolvable[]
fromMap
Creates a new iterator from a map.
map
Required
- Type: ComplexMap | {[ key: string ]: any} | {[ key: string ]: string} | {[ key: string ]: number} | {[ key: string ]: boolean}
fromResources
Creates a new iterator from a resource that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
Properties
Name | Type | Description |
---|---|---|
key | string | Returns the key of the current entry in the map that is being iterated over. |
value | any | Returns the value of the current item iterated over. |
key
Required
- Type: string
Returns the key of the current entry in the map that is being iterated over.
value
Required
- Type: any
Returns the value of the current item iterated over.
Fn
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
abs | {@link https://developer.hashicorp.com/terraform/language/functions/abs abs} returns the absolute value of the given number. In other words, if the number is zero or positive then it is returned as-is, but if it is negative then it is multiplied by -1 to make it positive before returning it. |
abspath | {@link https://developer.hashicorp.com/terraform/language/functions/abspath abspath} takes a string containing a filesystem path and converts it to an absolute path. That is, if the path is not absolute, it will be joined with the current working directory. |
alltrue | {@link https://developer.hashicorp.com/terraform/language/functions/alltrue alltrue} returns true if all elements in a given collection are true or "true" . It also returns true if the collection is empty. |
anytrue | {@link https://developer.hashicorp.com/terraform/language/functions/anytrue anytrue} returns true if any element in a given collection is true or "true" . It also returns false if the collection is empty. |
base64decode | {@link https://developer.hashicorp.com/terraform/language/functions/base64decode base64decode} takes a string containing a Base64 character sequence and returns the original string. |
base64encode | {@link https://developer.hashicorp.com/terraform/language/functions/base64encode base64encode} applies Base64 encoding to a string. |
base64gzip | {@link https://developer.hashicorp.com/terraform/language/functions/base64gzip base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding. |
base64sha256 | {@link https://developer.hashicorp.com/terraform/language/functions/base64sha256 base64sha256} computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha256("test")) since sha256() returns hexadecimal representation. |
base64sha512 | {@link https://developer.hashicorp.com/terraform/language/functions/base64sha512 base64sha512} computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha512("test")) since sha512() returns hexadecimal representation. |
basename | {@link https://developer.hashicorp.com/terraform/language/functions/basename basename} takes a string containing a filesystem path and removes all except the last portion from it. |
can | {@link https://developer.hashicorp.com/terraform/language/functions/can can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors. |
ceil | {@link https://developer.hashicorp.com/terraform/language/functions/ceil ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction. |
chomp | {@link https://developer.hashicorp.com/terraform/language/functions/chomp chomp} removes newline characters at the end of a string. |
chunklist | {@link https://developer.hashicorp.com/terraform/language/functions/chunklist chunklist} splits a single list into fixed-size chunks, returning a list of lists. |
cidrhost | {@link https://developer.hashicorp.com/terraform/language/functions/cidrhost cidrhost} calculates a full host IP address for a given host number within a given IP network address prefix. |
cidrnetmask | {@link https://developer.hashicorp.com/terraform/language/functions/cidrnetmask cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address. |
cidrsubnet | {@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnet cidrsubnet} calculates a subnet address within given IP network address prefix. |
cidrsubnets | {@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnets cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix. |
coalesce | {@link https://developer.hashicorp.com/terraform/language/functions/coalesce coalesce} takes any number of arguments and returns the first one that isn't null or an empty string. |
coalescelist | {@link https://developer.hashicorp.com/terraform/language/functions/coalescelist coalescelist} takes any number of list arguments and returns the first one that isn't empty. |
compact | {@link https://developer.hashicorp.com/terraform/language/functions/compact compact} takes a list of strings and returns a new list with any empty string elements removed. |
concat | {@link https://developer.hashicorp.com/terraform/language/functions/concat concat} takes two or more lists and combines them into a single list. |
contains | {@link https://developer.hashicorp.com/terraform/language/functions/contains contains} determines whether a given list or set contains a given single value as one of its elements. |
csvdecode | {@link https://developer.hashicorp.com/terraform/language/functions/csvdecode csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data. |
dirname | {@link https://developer.hashicorp.com/terraform/language/functions/dirname dirname} takes a string containing a filesystem path and removes the last portion from it. |
distinct | {@link https://developer.hashicorp.com/terraform/language/functions/distinct distinct} takes a list and returns a new list with any duplicate elements removed. |
element | {@link https://developer.hashicorp.com/terraform/language/functions/element element} retrieves a single element from a list. |
endswith | {@link https://developer.hashicorp.com/terraform/language/functions/endswith endswith} takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. |
file | {@link https://developer.hashicorp.com/terraform/language/functions/file file} reads the contents of a file at the given path and returns them as a string. |
filebase64 | {@link https://developer.hashicorp.com/terraform/language/functions/filebase64 filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string. |
filebase64sha256 | {@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha256 filebase64sha256} is a variant of base64sha256 that hashes the contents of a given file rather than a literal string. |
filebase64sha512 | {@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha512 filebase64sha512} is a variant of base64sha512 that hashes the contents of a given file rather than a literal string. |
fileexists | {@link https://developer.hashicorp.com/terraform/language/functions/fileexists fileexists} determines whether a file exists at a given path. |
filemd5 | {@link https://developer.hashicorp.com/terraform/language/functions/filemd5 filemd5} is a variant of md5 that hashes the contents of a given file rather than a literal string. |
fileset | {@link https://developer.hashicorp.com/terraform/language/functions/fileset fileset} enumerates a set of regular file names given a path and pattern. The path is automatically removed from the resulting set of file names and any result still containing path separators always returns forward slash (/ ) as the path separator for cross-system compatibility. |
filesha1 | {@link https://developer.hashicorp.com/terraform/language/functions/filesha1 filesha1} is a variant of sha1 that hashes the contents of a given file rather than a literal string. |
filesha256 | {@link https://developer.hashicorp.com/terraform/language/functions/filesha256 filesha256} is a variant of sha256 that hashes the contents of a given file rather than a literal string. |
filesha512 | {@link https://developer.hashicorp.com/terraform/language/functions/filesha512 filesha512} is a variant of sha512 that hashes the contents of a given file rather than a literal string. |
flatten | {@link https://developer.hashicorp.com/terraform/language/functions/flatten flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents. |
floor | {@link https://developer.hashicorp.com/terraform/language/functions/floor floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction. |
format | The {@link https://developer.hashicorp.com/terraform/language/functions/format format} function produces a string by formatting a number of other values according to a specification string. It is similar to the printf function in C, and other similar functions in other programming languages. |
formatdate | {@link https://developer.hashicorp.com/terraform/language/functions/formatdate formatdate} converts a timestamp into a different time format. |
formatlist | {@link https://developer.hashicorp.com/terraform/language/functions/formatlist formatlist} produces a list of strings by formatting a number of other values according to a specification string. |
indent | {@link https://developer.hashicorp.com/terraform/language/functions/indent indent} adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. |
index | {@link https://developer.hashicorp.com/terraform/language/functions/index index} finds the element index for a given value in a list. |
jsondecode | {@link https://developer.hashicorp.com/terraform/language/functions/jsondecode jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string. |
jsonencode | {@link https://developer.hashicorp.com/terraform/language/functions/jsonencode jsonencode} encodes a given value to a string using JSON syntax. |
keys | {@link https://developer.hashicorp.com/terraform/language/functions/keys keys} takes a map and returns a list containing the keys from that map. |
lengthOf | {@link https://developer.hashicorp.com/terraform/language/functions/length length} determines the length of a given list, map, or string. |
log | {@link https://developer.hashicorp.com/terraform/language/functions/log log} returns the logarithm of a given number in a given base. |
lower | {@link https://developer.hashicorp.com/terraform/language/functions/lower lower} converts all cased letters in the given string to lowercase. |
matchkeys | {@link https://developer.hashicorp.com/terraform/language/functions/matchkeys matchkeys} constructs a new list by taking a subset of elements from one list whose indexes match the corresponding indexes of values in another list. |
max | {@link https://developer.hashicorp.com/terraform/language/functions/max max} takes one or more numbers and returns the greatest number from the set. |
md5 | {@link https://developer.hashicorp.com/terraform/language/functions/md5 md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits. |
merge | {@link https://developer.hashicorp.com/terraform/language/functions/merge merge} takes an arbitrary number of maps or objects, and returns a single map or object that contains a merged set of elements from all arguments. |
min | {@link https://developer.hashicorp.com/terraform/language/functions/min min} takes one or more numbers and returns the smallest number from the set. |
nonsensitive | {@link https://developer.hashicorp.com/terraform/language/functions/nonsensitive nonsensitive} takes a sensitive value and returns a copy of that value with the sensitive marking removed, thereby exposing the sensitive value. |
one | {@link https://developer.hashicorp.com/terraform/language/functions/one one} takes a list, set, or tuple value with either zero or one elements. If the collection is empty, one returns null . Otherwise, one returns the first element. If there are two or more elements then one will return an error. |
parseint | {@link https://developer.hashicorp.com/terraform/language/functions/parseint parseint} parses the given string as a representation of an integer in the specified base and returns the resulting number. The base must be between 2 and 62 inclusive. |
pathexpand | {@link https://developer.hashicorp.com/terraform/language/functions/pathexpand pathexpand} takes a filesystem path that might begin with a ~ segment, and if so it replaces that segment with the current user's home directory path. |
plantimestamp | {@link https://developer.hashicorp.com/terraform/language/functions/plantimestamp plantimestamp} returns a UTC timestamp string in RFC 3339 format, fixed to a constant time representing the time of the plan. |
pow | {@link https://developer.hashicorp.com/terraform/language/functions/pow pow} calculates an exponent, by raising its first argument to the power of the second argument. |
regex | {@link https://developer.hashicorp.com/terraform/language/functions/regex regex} applies a regular expression to a string and returns the matching substrings. |
regexall | {@link https://developer.hashicorp.com/terraform/language/functions/regexall regexall} applies a regular expression to a string and returns a list of all matches. |
replace | {@link https://developer.hashicorp.com/terraform/language/functions/replace replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string. |
reverse | {@link https://developer.hashicorp.com/terraform/language/functions/reverse reverse} takes a sequence and produces a new sequence of the same length with all of the same elements as the given sequence but in reverse order. |
rsadecrypt | {@link https://developer.hashicorp.com/terraform/language/functions/rsadecrypt rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext. |
sensitive | {@link https://developer.hashicorp.com/terraform/language/functions/sensitive sensitive} takes any value and returns a copy of it marked so that Terraform will treat it as sensitive, with the same meaning and behavior as for sensitive input variables. |
setintersection | The {@link https://developer.hashicorp.com/terraform/language/functions/setintersection setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. In other words, it computes the intersection of the sets. |
setproduct | The {@link https://developer.hashicorp.com/terraform/language/functions/setproduct setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product. |
setsubtract | The {@link https://developer.hashicorp.com/terraform/language/functions/setsubtract setsubtract} function returns a new set containing the elements from the first set that are not present in the second set. In other words, it computes the relative complement of the second set. |
setunion | The {@link https://developer.hashicorp.com/terraform/language/functions/setunion setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets. In other words, it computes the union of the sets. |
sha1 | {@link https://developer.hashicorp.com/terraform/language/functions/sha1 sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits. |
sha256 | {@link https://developer.hashicorp.com/terraform/language/functions/sha256 sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits. |
sha512 | {@link https://developer.hashicorp.com/terraform/language/functions/sha512 sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits. |
signum | {@link https://developer.hashicorp.com/terraform/language/functions/signum signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign. |
slice | {@link https://developer.hashicorp.com/terraform/language/functions/slice slice} extracts some consecutive elements from within a list. |
sort | {@link https://developer.hashicorp.com/terraform/language/functions/sort sort} takes a list of strings and returns a new list with those strings sorted lexicographically. |
split | {@link https://developer.hashicorp.com/terraform/language/functions/split split} produces a list by dividing a given string at all occurrences of a given separator. |
startswith | {@link https://developer.hashicorp.com/terraform/language/functions/startswith startswith} takes two values: a string to check and a prefix string. The function returns true if the string begins with that exact prefix. |
strcontains | {@link https://developer.hashicorp.com/terraform/language/functions/strcontains strcontains} takes two values: a string to check and an expected substring. The function returns true if the string has the substring contained within it. |
strrev | {@link https://developer.hashicorp.com/terraform/language/functions/strrev strrev} reverses the characters in a string. Note that the characters are treated as Unicode characters (in technical terms, Unicode grapheme cluster boundaries are respected). |
substr | {@link https://developer.hashicorp.com/terraform/language/functions/substr substr} extracts a substring from a given string by offset and (maximum) length. |
sum | {@link https://developer.hashicorp.com/terraform/language/functions/sum sum} takes a list or set of numbers and returns the sum of those numbers. |
templatefile | {@link https://developer.hashicorp.com/terraform/language/functions/templatefile templatefile} reads the file at the given path and renders its content as a template using a supplied set of template variables. |
textdecodebase64 | {@link https://developer.hashicorp.com/terraform/language/functions/textdecodebase64 textdecodebase64} function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. |
textencodebase64 | {@link https://developer.hashicorp.com/terraform/language/functions/textencodebase64 textencodebase64} encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. |
timeadd | {@link https://developer.hashicorp.com/terraform/language/functions/timeadd timeadd} adds a duration to a timestamp, returning a new timestamp. |
timecmp | {@link https://developer.hashicorp.com/terraform/language/functions/timecmp timecmp} compares two timestamps and returns a number that represents the ordering of the instants those timestamps represent. |
timestamp | {@link https://developer.hashicorp.com/terraform/language/functions/timestamp timestamp} returns a UTC timestamp string in RFC 3339 format. |
title | {@link https://developer.hashicorp.com/terraform/language/functions/title title} converts the first letter of each word in the given string to uppercase. |
tobool | {@link https://developer.hashicorp.com/terraform/language/functions/tobool tobool} converts its argument to a boolean value. |
tolist | {@link https://developer.hashicorp.com/terraform/language/functions/tolist tolist} converts its argument to a list value. |
tomap | {@link https://developer.hashicorp.com/terraform/language/functions/tomap tomap} converts its argument to a map value. |
tonumber | {@link https://developer.hashicorp.com/terraform/language/functions/tonumber tonumber} converts its argument to a number value. |
toset | {@link https://developer.hashicorp.com/terraform/language/functions/toset toset} converts its argument to a set value. |
tostring | {@link https://developer.hashicorp.com/terraform/language/functions/tostring tostring} converts its argument to a string value. |
transpose | {@link https://developer.hashicorp.com/terraform/language/functions/transpose transpose} takes a map of lists of strings and swaps the keys and values to produce a new map of lists of strings. |
trim | {@link https://developer.hashicorp.com/terraform/language/functions/trim trim} removes the specified set of characters from the start and end of the given string. |
trimprefix | {@link https://developer.hashicorp.com/terraform/language/functions/trimprefix trimprefix} removes the specified prefix from the start of the given string. If the string does not start with the prefix, the string is returned unchanged. |
trimspace | {@link https://developer.hashicorp.com/terraform/language/functions/trimspace trimspace} removes any space characters from the start and end of the given string. |
trimsuffix | {@link https://developer.hashicorp.com/terraform/language/functions/trimsuffix trimsuffix} removes the specified suffix from the end of the given string. |
try | {@link https://developer.hashicorp.com/terraform/language/functions/try try} evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. |
upper | {@link https://developer.hashicorp.com/terraform/language/functions/upper upper} converts all cased letters in the given string to uppercase. |
urlencode | {@link https://developer.hashicorp.com/terraform/language/functions/urlencode urlencode} applies URL encoding to a given string. |
uuid | {@link https://developer.hashicorp.com/terraform/language/functions/uuid uuid} generates a unique identifier string. |
uuidv5 | {@link https://developer.hashicorp.com/terraform/language/functions/uuidv5 uuidv5} generates a name-based UUID, as described in RFC 4122 section 4.3, also known as a "version 5" UUID. |
values | {@link https://developer.hashicorp.com/terraform/language/functions/values values} takes a map and returns a list containing the values of the elements in that map. |
yamldecode | {@link https://developer.hashicorp.com/terraform/language/functions/yamldecode yamldecode} parses a string as a subset of YAML, and produces a representation of its value. |
yamlencode | {@link https://developer.hashicorp.com/terraform/language/functions/yamlencode yamlencode} encodes a given value to a string using YAML 1.2 block syntax. |
zipmap | {@link https://developer.hashicorp.com/terraform/language/functions/zipmap zipmap} constructs a map from a list of keys and a corresponding list of values. |
bcrypt | {@link /terraform/docs/language/functions/bcrypt.html bcrypt} computes a hash of the given string using the Blowfish cipher, returning a string in the Modular Crypt Format usually expected in the shadow password file on many Unix systems. |
conditional | {@link https://developer.hashicorp.com/terraform/language/expressions/conditionals} A conditional expression uses the value of a boolean expression to select one of two values. |
join | {@link /terraform/docs/language/functions/join.html join} produces a string by concatenating together all elements of a given list of strings with the given delimiter. |
lookup | {@link /terraform/docs/language/functions/lookup.html lookup} retrieves the value of a single element from a map, given its key. If the given key does not exist, the given default value is returned instead. |
lookupNested | returns a property access expression that accesses the property at the given path in the given inputMap. |
range | {@link /terraform/docs/language/functions/range.html range} generates a list of numbers using a start value, a limit value, and a step value. |
rawString | Use this function to wrap a string and escape it properly for the use in Terraform This is only needed in certain scenarios (e.g., if you have unescaped double quotes in the string). |
abs
{@link https://developer.hashicorp.com/terraform/language/functions/abs abs} returns the absolute value of the given number. In other words, if the number is zero or positive then it is returned as-is, but if it is negative then it is multiplied by -1 to make it positive before returning it.
num
Required
- Type: number
abspath
{@link https://developer.hashicorp.com/terraform/language/functions/abspath abspath} takes a string containing a filesystem path and converts it to an absolute path. That is, if the path is not absolute, it will be joined with the current working directory.
path
Required
- Type: string
alltrue
{@link https://developer.hashicorp.com/terraform/language/functions/alltrue alltrue} returns true
if all elements in a given collection are true
or "true"
. It also returns true
if the collection is empty.
list
Required
- Type: any[]
anytrue
{@link https://developer.hashicorp.com/terraform/language/functions/anytrue anytrue} returns true
if any element in a given collection is true
or "true"
. It also returns false
if the collection is empty.
list
Required
- Type: any[]
base64decode
{@link https://developer.hashicorp.com/terraform/language/functions/base64decode base64decode} takes a string containing a Base64 character sequence and returns the original string.
str
Required
- Type: string
base64encode
{@link https://developer.hashicorp.com/terraform/language/functions/base64encode base64encode} applies Base64 encoding to a string.
str
Required
- Type: string
base64gzip
{@link https://developer.hashicorp.com/terraform/language/functions/base64gzip base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding.
str
Required
- Type: string
base64sha256
{@link https://developer.hashicorp.com/terraform/language/functions/base64sha256 base64sha256} computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha256("test"))
since sha256()
returns hexadecimal representation.
str
Required
- Type: string
base64sha512
{@link https://developer.hashicorp.com/terraform/language/functions/base64sha512 base64sha512} computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha512("test"))
since sha512()
returns hexadecimal representation.
str
Required
- Type: string
basename
{@link https://developer.hashicorp.com/terraform/language/functions/basename basename} takes a string containing a filesystem path and removes all except the last portion from it.
path
Required
- Type: string
can
{@link https://developer.hashicorp.com/terraform/language/functions/can can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors.
expression
Required
- Type: any
ceil
{@link https://developer.hashicorp.com/terraform/language/functions/ceil ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction.
num
Required
- Type: number
chomp
{@link https://developer.hashicorp.com/terraform/language/functions/chomp chomp} removes newline characters at the end of a string.
str
Required
- Type: string
chunklist
{@link https://developer.hashicorp.com/terraform/language/functions/chunklist chunklist} splits a single list into fixed-size chunks, returning a list of lists.
list
Required
- Type: any[]
size
Required
- Type: number
cidrhost
{@link https://developer.hashicorp.com/terraform/language/functions/cidrhost cidrhost} calculates a full host IP address for a given host number within a given IP network address prefix.
prefix
Required
- Type: string
hostnum
Required
- Type: number
cidrnetmask
{@link https://developer.hashicorp.com/terraform/language/functions/cidrnetmask cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address.
prefix
Required
- Type: string
cidrsubnet
{@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnet cidrsubnet} calculates a subnet address within given IP network address prefix.
prefix
Required
- Type: string
newbits
Required
- Type: number
netnum
Required
- Type: number
cidrsubnets
{@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnets cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix.
prefix
Required
- Type: string
newbits
Required
- Type: number[]
coalesce
{@link https://developer.hashicorp.com/terraform/language/functions/coalesce coalesce} takes any number of arguments and returns the first one that isn't null or an empty string.
vals
Required
- Type: any[]
coalescelist
{@link https://developer.hashicorp.com/terraform/language/functions/coalescelist coalescelist} takes any number of list arguments and returns the first one that isn't empty.
vals
Required
- Type: any[]
compact
{@link https://developer.hashicorp.com/terraform/language/functions/compact compact} takes a list of strings and returns a new list with any empty string elements removed.
list
Required
- Type: string[]
concat
{@link https://developer.hashicorp.com/terraform/language/functions/concat concat} takes two or more lists and combines them into a single list.
seqs
Required
- Type: any[]
contains
{@link https://developer.hashicorp.com/terraform/language/functions/contains contains} determines whether a given list or set contains a given single value as one of its elements.
list
Required
- Type: any
value
Required
- Type: any
csvdecode
{@link https://developer.hashicorp.com/terraform/language/functions/csvdecode csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data.
str
Required
- Type: string
dirname
{@link https://developer.hashicorp.com/terraform/language/functions/dirname dirname} takes a string containing a filesystem path and removes the last portion from it.
path
Required
- Type: string
distinct
{@link https://developer.hashicorp.com/terraform/language/functions/distinct distinct} takes a list and returns a new list with any duplicate elements removed.
list
Required
- Type: any[]
element
{@link https://developer.hashicorp.com/terraform/language/functions/element element} retrieves a single element from a list.
list
Required
- Type: any
index
Required
- Type: number
endswith
{@link https://developer.hashicorp.com/terraform/language/functions/endswith endswith} takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix.
str
Required
- Type: string
suffix
Required
- Type: string
file
{@link https://developer.hashicorp.com/terraform/language/functions/file file} reads the contents of a file at the given path and returns them as a string.
path
Required
- Type: string
filebase64
{@link https://developer.hashicorp.com/terraform/language/functions/filebase64 filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string.
path
Required
- Type: string
filebase64sha256
{@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha256 filebase64sha256} is a variant of base64sha256
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
filebase64sha512
{@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha512 filebase64sha512} is a variant of base64sha512
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
fileexists
{@link https://developer.hashicorp.com/terraform/language/functions/fileexists fileexists} determines whether a file exists at a given path.
path
Required
- Type: string
filemd5
{@link https://developer.hashicorp.com/terraform/language/functions/filemd5 filemd5} is a variant of md5
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
fileset
{@link https://developer.hashicorp.com/terraform/language/functions/fileset fileset} enumerates a set of regular file names given a path and pattern. The path is automatically removed from the resulting set of file names and any result still containing path separators always returns forward slash (/
) as the path separator for cross-system compatibility.
path
Required
- Type: string
pattern
Required
- Type: string
filesha1
{@link https://developer.hashicorp.com/terraform/language/functions/filesha1 filesha1} is a variant of sha1
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
filesha256
{@link https://developer.hashicorp.com/terraform/language/functions/filesha256 filesha256} is a variant of sha256
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
filesha512
{@link https://developer.hashicorp.com/terraform/language/functions/filesha512 filesha512} is a variant of sha512
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
flatten
{@link https://developer.hashicorp.com/terraform/language/functions/flatten flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents.
list
Required
- Type: any
floor
{@link https://developer.hashicorp.com/terraform/language/functions/floor floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction.
num
Required
- Type: number
format
The {@link https://developer.hashicorp.com/terraform/language/functions/format format} function produces a string by formatting a number of other values according to a specification string. It is similar to the printf
function in C, and other similar functions in other programming languages.
format
Required
- Type: string
args
Required
- Type: any[]
formatdate
{@link https://developer.hashicorp.com/terraform/language/functions/formatdate formatdate} converts a timestamp into a different time format.
format
Required
- Type: string
time
Required
- Type: string
formatlist
{@link https://developer.hashicorp.com/terraform/language/functions/formatlist formatlist} produces a list of strings by formatting a number of other values according to a specification string.
format
Required
- Type: string
args
Required
- Type: any[]
indent
{@link https://developer.hashicorp.com/terraform/language/functions/indent indent} adds a given number of spaces to the beginnings of all but the first line in a given multi-line string.
spaces
Required
- Type: number
str
Required
- Type: string
index
{@link https://developer.hashicorp.com/terraform/language/functions/index index} finds the element index for a given value in a list.
list
Required
- Type: any
value
Required
- Type: any
jsondecode
{@link https://developer.hashicorp.com/terraform/language/functions/jsondecode jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string.
str
Required
- Type: string
jsonencode
{@link https://developer.hashicorp.com/terraform/language/functions/jsonencode jsonencode} encodes a given value to a string using JSON syntax.
val
Required
- Type: any
keys
{@link https://developer.hashicorp.com/terraform/language/functions/keys keys} takes a map and returns a list containing the keys from that map.
inputMap
Required
- Type: any
lengthOf
{@link https://developer.hashicorp.com/terraform/language/functions/length length} determines the length of a given list, map, or string.
value
Required
- Type: any
log
{@link https://developer.hashicorp.com/terraform/language/functions/log log} returns the logarithm of a given number in a given base.
num
Required
- Type: number
base
Required
- Type: number
lower
{@link https://developer.hashicorp.com/terraform/language/functions/lower lower} converts all cased letters in the given string to lowercase.
str
Required
- Type: string
matchkeys
{@link https://developer.hashicorp.com/terraform/language/functions/matchkeys matchkeys} constructs a new list by taking a subset of elements from one list whose indexes match the corresponding indexes of values in another list.
values
Required
- Type: any[]
keys
Required
- Type: any[]
searchset
Required
- Type: any[]
max
{@link https://developer.hashicorp.com/terraform/language/functions/max max} takes one or more numbers and returns the greatest number from the set.
numbers
Required
- Type: number[]
md5
{@link https://developer.hashicorp.com/terraform/language/functions/md5 md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
merge
{@link https://developer.hashicorp.com/terraform/language/functions/merge merge} takes an arbitrary number of maps or objects, and returns a single map or object that contains a merged set of elements from all arguments.
maps
Required
- Type: any[]
min
{@link https://developer.hashicorp.com/terraform/language/functions/min min} takes one or more numbers and returns the smallest number from the set.
numbers
Required
- Type: number[]
nonsensitive
{@link https://developer.hashicorp.com/terraform/language/functions/nonsensitive nonsensitive} takes a sensitive value and returns a copy of that value with the sensitive marking removed, thereby exposing the sensitive value.
value
Required
- Type: any
one
{@link https://developer.hashicorp.com/terraform/language/functions/one one} takes a list, set, or tuple value with either zero or one elements. If the collection is empty, one
returns null
. Otherwise, one
returns the first element. If there are two or more elements then one
will return an error.
list
Required
- Type: any
parseint
{@link https://developer.hashicorp.com/terraform/language/functions/parseint parseint} parses the given string as a representation of an integer in the specified base and returns the resulting number. The base must be between 2 and 62 inclusive.
number
Required
- Type: any
base
Required
- Type: number
pathexpand
{@link https://developer.hashicorp.com/terraform/language/functions/pathexpand pathexpand} takes a filesystem path that might begin with a ~
segment, and if so it replaces that segment with the current user's home directory path.
path
Required
- Type: string
plantimestamp
{@link https://developer.hashicorp.com/terraform/language/functions/plantimestamp plantimestamp} returns a UTC timestamp string in RFC 3339 format, fixed to a constant time representing the time of the plan.
pow
{@link https://developer.hashicorp.com/terraform/language/functions/pow pow} calculates an exponent, by raising its first argument to the power of the second argument.
num
Required
- Type: number
power
Required
- Type: number
regex
{@link https://developer.hashicorp.com/terraform/language/functions/regex regex} applies a regular expression to a string and returns the matching substrings.
pattern
Required
- Type: string
str
Required
- Type: string
regexall
{@link https://developer.hashicorp.com/terraform/language/functions/regexall regexall} applies a regular expression to a string and returns a list of all matches.
pattern
Required
- Type: string
str
Required
- Type: string
replace
{@link https://developer.hashicorp.com/terraform/language/functions/replace replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string.
str
Required
- Type: string
substr
Required
- Type: string
replace
Required
- Type: string
reverse
{@link https://developer.hashicorp.com/terraform/language/functions/reverse reverse} takes a sequence and produces a new sequence of the same length with all of the same elements as the given sequence but in reverse order.
list
Required
- Type: any
rsadecrypt
{@link https://developer.hashicorp.com/terraform/language/functions/rsadecrypt rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext.
ciphertext
Required
- Type: string
privatekey
Required
- Type: string
sensitive
{@link https://developer.hashicorp.com/terraform/language/functions/sensitive sensitive} takes any value and returns a copy of it marked so that Terraform will treat it as sensitive, with the same meaning and behavior as for sensitive input variables.
value
Required
- Type: any
setintersection
The {@link https://developer.hashicorp.com/terraform/language/functions/setintersection setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. In other words, it computes the intersection of the sets.
first_set
Required
- Type: any[]
other_sets
Required
- Type: any[][]
setproduct
The {@link https://developer.hashicorp.com/terraform/language/functions/setproduct setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product.
sets
Required
- Type: any[]
setsubtract
The {@link https://developer.hashicorp.com/terraform/language/functions/setsubtract setsubtract} function returns a new set containing the elements from the first set that are not present in the second set. In other words, it computes the relative complement of the second set.
a
Required
- Type: any[]
b
Required
- Type: any[]
setunion
The {@link https://developer.hashicorp.com/terraform/language/functions/setunion setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets. In other words, it computes the union of the sets.
first_set
Required
- Type: any[]
other_sets
Required
- Type: any[][]
sha1
{@link https://developer.hashicorp.com/terraform/language/functions/sha1 sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
sha256
{@link https://developer.hashicorp.com/terraform/language/functions/sha256 sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
sha512
{@link https://developer.hashicorp.com/terraform/language/functions/sha512 sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
signum
{@link https://developer.hashicorp.com/terraform/language/functions/signum signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign.
num
Required
- Type: number
slice
{@link https://developer.hashicorp.com/terraform/language/functions/slice slice} extracts some consecutive elements from within a list.
list
Required
- Type: any
start_index
Required
- Type: number
end_index
Required
- Type: number
sort
{@link https://developer.hashicorp.com/terraform/language/functions/sort sort} takes a list of strings and returns a new list with those strings sorted lexicographically.
list
Required
- Type: string[]
split
{@link https://developer.hashicorp.com/terraform/language/functions/split split} produces a list by dividing a given string at all occurrences of a given separator.
separator
Required
- Type: string
str
Required
- Type: string
startswith
{@link https://developer.hashicorp.com/terraform/language/functions/startswith startswith} takes two values: a string to check and a prefix string. The function returns true if the string begins with that exact prefix.
str
Required
- Type: string
prefix
Required
- Type: string
strcontains
{@link https://developer.hashicorp.com/terraform/language/functions/strcontains strcontains} takes two values: a string to check and an expected substring. The function returns true if the string has the substring contained within it.
str
Required
- Type: string
substr
Required
- Type: string
strrev
{@link https://developer.hashicorp.com/terraform/language/functions/strrev strrev} reverses the characters in a string. Note that the characters are treated as Unicode characters (in technical terms, Unicode grapheme cluster boundaries are respected).
str
Required
- Type: string
substr
{@link https://developer.hashicorp.com/terraform/language/functions/substr substr} extracts a substring from a given string by offset and (maximum) length.
str
Required
- Type: string
offset
Required
- Type: number
length
Required
- Type: number
sum
{@link https://developer.hashicorp.com/terraform/language/functions/sum sum} takes a list or set of numbers and returns the sum of those numbers.
list
Required
- Type: any
templatefile
{@link https://developer.hashicorp.com/terraform/language/functions/templatefile templatefile} reads the file at the given path and renders its content as a template using a supplied set of template variables.
path
Required
- Type: string
vars
Required
- Type: any
textdecodebase64
{@link https://developer.hashicorp.com/terraform/language/functions/textdecodebase64 textdecodebase64} function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding.
source
Required
- Type: string
encoding
Required
- Type: string
textencodebase64
{@link https://developer.hashicorp.com/terraform/language/functions/textencodebase64 textencodebase64} encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters.
str
Required
- Type: string
encoding
Required
- Type: string
timeadd
{@link https://developer.hashicorp.com/terraform/language/functions/timeadd timeadd} adds a duration to a timestamp, returning a new timestamp.
timestamp
Required
- Type: string
duration
Required
- Type: string
timecmp
{@link https://developer.hashicorp.com/terraform/language/functions/timecmp timecmp} compares two timestamps and returns a number that represents the ordering of the instants those timestamps represent.
timestamp_a
Required
- Type: string
timestamp_b
Required
- Type: string
timestamp
{@link https://developer.hashicorp.com/terraform/language/functions/timestamp timestamp} returns a UTC timestamp string in RFC 3339 format.
title
{@link https://developer.hashicorp.com/terraform/language/functions/title title} converts the first letter of each word in the given string to uppercase.
str
Required
- Type: string
tobool
{@link https://developer.hashicorp.com/terraform/language/functions/tobool tobool} converts its argument to a boolean value.
v
Required
- Type: any
tolist
{@link https://developer.hashicorp.com/terraform/language/functions/tolist tolist} converts its argument to a list value.
v
Required
- Type: any
tomap
{@link https://developer.hashicorp.com/terraform/language/functions/tomap tomap} converts its argument to a map value.
v
Required
- Type: any
tonumber
{@link https://developer.hashicorp.com/terraform/language/functions/tonumber tonumber} converts its argument to a number value.
v
Required
- Type: any
toset
{@link https://developer.hashicorp.com/terraform/language/functions/toset toset} converts its argument to a set value.
v
Required
- Type: any
tostring
{@link https://developer.hashicorp.com/terraform/language/functions/tostring tostring} converts its argument to a string value.
v
Required
- Type: any
transpose
{@link https://developer.hashicorp.com/terraform/language/functions/transpose transpose} takes a map of lists of strings and swaps the keys and values to produce a new map of lists of strings.
values
Required
- Type: any
trim
{@link https://developer.hashicorp.com/terraform/language/functions/trim trim} removes the specified set of characters from the start and end of the given string.
str
Required
- Type: string
cutset
Required
- Type: string
trimprefix
{@link https://developer.hashicorp.com/terraform/language/functions/trimprefix trimprefix} removes the specified prefix from the start of the given string. If the string does not start with the prefix, the string is returned unchanged.
str
Required
- Type: string
prefix
Required
- Type: string
trimspace
{@link https://developer.hashicorp.com/terraform/language/functions/trimspace trimspace} removes any space characters from the start and end of the given string.
str
Required
- Type: string
trimsuffix
{@link https://developer.hashicorp.com/terraform/language/functions/trimsuffix trimsuffix} removes the specified suffix from the end of the given string.
str
Required
- Type: string
suffix
Required
- Type: string
try
{@link https://developer.hashicorp.com/terraform/language/functions/try try} evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors.
expressions
Required
- Type: any[]
upper
{@link https://developer.hashicorp.com/terraform/language/functions/upper upper} converts all cased letters in the given string to uppercase.
str
Required
- Type: string
urlencode
{@link https://developer.hashicorp.com/terraform/language/functions/urlencode urlencode} applies URL encoding to a given string.
str
Required
- Type: string
uuid
{@link https://developer.hashicorp.com/terraform/language/functions/uuid uuid} generates a unique identifier string.
uuidv5
{@link https://developer.hashicorp.com/terraform/language/functions/uuidv5 uuidv5} generates a name-based UUID, as described in RFC 4122 section 4.3, also known as a "version 5" UUID.
namespace
Required
- Type: string
name
Required
- Type: string
values
{@link https://developer.hashicorp.com/terraform/language/functions/values values} takes a map and returns a list containing the values of the elements in that map.
mapping
Required
- Type: any
yamldecode
{@link https://developer.hashicorp.com/terraform/language/functions/yamldecode yamldecode} parses a string as a subset of YAML, and produces a representation of its value.
src
Required
- Type: string
yamlencode
{@link https://developer.hashicorp.com/terraform/language/functions/yamlencode yamlencode} encodes a given value to a string using YAML 1.2 block syntax.
value
Required
- Type: any
zipmap
{@link https://developer.hashicorp.com/terraform/language/functions/zipmap zipmap} constructs a map from a list of keys and a corresponding list of values.
keys
Required
- Type: string[]
values
Required
- Type: any
bcrypt
{@link /terraform/docs/language/functions/bcrypt.html bcrypt} computes a hash of the given string using the Blowfish cipher, returning a string in the Modular Crypt Format usually expected in the shadow password file on many Unix systems.
str
Required
- Type: string
cost
Optional
- Type: number
conditional
{@link https://developer.hashicorp.com/terraform/language/expressions/conditionals} A conditional expression uses the value of a boolean expression to select one of two values.
condition
Required
- Type: any
trueValue
Required
- Type: any
falseValue
Required
- Type: any
join
{@link /terraform/docs/language/functions/join.html join} produces a string by concatenating together all elements of a given list of strings with the given delimiter.
separator
Required
- Type: string
list
Required
- Type: string[]
lookup
{@link /terraform/docs/language/functions/lookup.html lookup} retrieves the value of a single element from a map, given its key. If the given key does not exist, the given default value is returned instead.
inputMap
Required
- Type: any
key
Required
- Type: string
defaultValue
Optional
- Type: any
lookupNested
returns a property access expression that accesses the property at the given path in the given inputMap.
For example lookupNested(x, ["a", "b", "c"]) will return a Terraform expression like x["a"]["b"]["c"]
inputMap
Required
- Type: any
path
Required
- Type: any[]
range
{@link /terraform/docs/language/functions/range.html range} generates a list of numbers using a start value, a limit value, and a step value.
start
Required
- Type: number
limit
Required
- Type: number
step
Optional
- Type: number
rawString
Use this function to wrap a string and escape it properly for the use in Terraform This is only needed in certain scenarios (e.g., if you have unescaped double quotes in the string).
str
Required
- Type: string
FnGenerated
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
abs | {@link https://developer.hashicorp.com/terraform/language/functions/abs abs} returns the absolute value of the given number. In other words, if the number is zero or positive then it is returned as-is, but if it is negative then it is multiplied by -1 to make it positive before returning it. |
abspath | {@link https://developer.hashicorp.com/terraform/language/functions/abspath abspath} takes a string containing a filesystem path and converts it to an absolute path. That is, if the path is not absolute, it will be joined with the current working directory. |
alltrue | {@link https://developer.hashicorp.com/terraform/language/functions/alltrue alltrue} returns true if all elements in a given collection are true or "true" . It also returns true if the collection is empty. |
anytrue | {@link https://developer.hashicorp.com/terraform/language/functions/anytrue anytrue} returns true if any element in a given collection is true or "true" . It also returns false if the collection is empty. |
base64decode | {@link https://developer.hashicorp.com/terraform/language/functions/base64decode base64decode} takes a string containing a Base64 character sequence and returns the original string. |
base64encode | {@link https://developer.hashicorp.com/terraform/language/functions/base64encode base64encode} applies Base64 encoding to a string. |
base64gzip | {@link https://developer.hashicorp.com/terraform/language/functions/base64gzip base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding. |
base64sha256 | {@link https://developer.hashicorp.com/terraform/language/functions/base64sha256 base64sha256} computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha256("test")) since sha256() returns hexadecimal representation. |
base64sha512 | {@link https://developer.hashicorp.com/terraform/language/functions/base64sha512 base64sha512} computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha512("test")) since sha512() returns hexadecimal representation. |
basename | {@link https://developer.hashicorp.com/terraform/language/functions/basename basename} takes a string containing a filesystem path and removes all except the last portion from it. |
can | {@link https://developer.hashicorp.com/terraform/language/functions/can can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors. |
ceil | {@link https://developer.hashicorp.com/terraform/language/functions/ceil ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction. |
chomp | {@link https://developer.hashicorp.com/terraform/language/functions/chomp chomp} removes newline characters at the end of a string. |
chunklist | {@link https://developer.hashicorp.com/terraform/language/functions/chunklist chunklist} splits a single list into fixed-size chunks, returning a list of lists. |
cidrhost | {@link https://developer.hashicorp.com/terraform/language/functions/cidrhost cidrhost} calculates a full host IP address for a given host number within a given IP network address prefix. |
cidrnetmask | {@link https://developer.hashicorp.com/terraform/language/functions/cidrnetmask cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address. |
cidrsubnet | {@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnet cidrsubnet} calculates a subnet address within given IP network address prefix. |
cidrsubnets | {@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnets cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix. |
coalesce | {@link https://developer.hashicorp.com/terraform/language/functions/coalesce coalesce} takes any number of arguments and returns the first one that isn't null or an empty string. |
coalescelist | {@link https://developer.hashicorp.com/terraform/language/functions/coalescelist coalescelist} takes any number of list arguments and returns the first one that isn't empty. |
compact | {@link https://developer.hashicorp.com/terraform/language/functions/compact compact} takes a list of strings and returns a new list with any empty string elements removed. |
concat | {@link https://developer.hashicorp.com/terraform/language/functions/concat concat} takes two or more lists and combines them into a single list. |
contains | {@link https://developer.hashicorp.com/terraform/language/functions/contains contains} determines whether a given list or set contains a given single value as one of its elements. |
csvdecode | {@link https://developer.hashicorp.com/terraform/language/functions/csvdecode csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data. |
dirname | {@link https://developer.hashicorp.com/terraform/language/functions/dirname dirname} takes a string containing a filesystem path and removes the last portion from it. |
distinct | {@link https://developer.hashicorp.com/terraform/language/functions/distinct distinct} takes a list and returns a new list with any duplicate elements removed. |
element | {@link https://developer.hashicorp.com/terraform/language/functions/element element} retrieves a single element from a list. |
endswith | {@link https://developer.hashicorp.com/terraform/language/functions/endswith endswith} takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix. |
file | {@link https://developer.hashicorp.com/terraform/language/functions/file file} reads the contents of a file at the given path and returns them as a string. |
filebase64 | {@link https://developer.hashicorp.com/terraform/language/functions/filebase64 filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string. |
filebase64sha256 | {@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha256 filebase64sha256} is a variant of base64sha256 that hashes the contents of a given file rather than a literal string. |
filebase64sha512 | {@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha512 filebase64sha512} is a variant of base64sha512 that hashes the contents of a given file rather than a literal string. |
fileexists | {@link https://developer.hashicorp.com/terraform/language/functions/fileexists fileexists} determines whether a file exists at a given path. |
filemd5 | {@link https://developer.hashicorp.com/terraform/language/functions/filemd5 filemd5} is a variant of md5 that hashes the contents of a given file rather than a literal string. |
fileset | {@link https://developer.hashicorp.com/terraform/language/functions/fileset fileset} enumerates a set of regular file names given a path and pattern. The path is automatically removed from the resulting set of file names and any result still containing path separators always returns forward slash (/ ) as the path separator for cross-system compatibility. |
filesha1 | {@link https://developer.hashicorp.com/terraform/language/functions/filesha1 filesha1} is a variant of sha1 that hashes the contents of a given file rather than a literal string. |
filesha256 | {@link https://developer.hashicorp.com/terraform/language/functions/filesha256 filesha256} is a variant of sha256 that hashes the contents of a given file rather than a literal string. |
filesha512 | {@link https://developer.hashicorp.com/terraform/language/functions/filesha512 filesha512} is a variant of sha512 that hashes the contents of a given file rather than a literal string. |
flatten | {@link https://developer.hashicorp.com/terraform/language/functions/flatten flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents. |
floor | {@link https://developer.hashicorp.com/terraform/language/functions/floor floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction. |
format | The {@link https://developer.hashicorp.com/terraform/language/functions/format format} function produces a string by formatting a number of other values according to a specification string. It is similar to the printf function in C, and other similar functions in other programming languages. |
formatdate | {@link https://developer.hashicorp.com/terraform/language/functions/formatdate formatdate} converts a timestamp into a different time format. |
formatlist | {@link https://developer.hashicorp.com/terraform/language/functions/formatlist formatlist} produces a list of strings by formatting a number of other values according to a specification string. |
indent | {@link https://developer.hashicorp.com/terraform/language/functions/indent indent} adds a given number of spaces to the beginnings of all but the first line in a given multi-line string. |
index | {@link https://developer.hashicorp.com/terraform/language/functions/index index} finds the element index for a given value in a list. |
jsondecode | {@link https://developer.hashicorp.com/terraform/language/functions/jsondecode jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string. |
jsonencode | {@link https://developer.hashicorp.com/terraform/language/functions/jsonencode jsonencode} encodes a given value to a string using JSON syntax. |
keys | {@link https://developer.hashicorp.com/terraform/language/functions/keys keys} takes a map and returns a list containing the keys from that map. |
lengthOf | {@link https://developer.hashicorp.com/terraform/language/functions/length length} determines the length of a given list, map, or string. |
log | {@link https://developer.hashicorp.com/terraform/language/functions/log log} returns the logarithm of a given number in a given base. |
lower | {@link https://developer.hashicorp.com/terraform/language/functions/lower lower} converts all cased letters in the given string to lowercase. |
matchkeys | {@link https://developer.hashicorp.com/terraform/language/functions/matchkeys matchkeys} constructs a new list by taking a subset of elements from one list whose indexes match the corresponding indexes of values in another list. |
max | {@link https://developer.hashicorp.com/terraform/language/functions/max max} takes one or more numbers and returns the greatest number from the set. |
md5 | {@link https://developer.hashicorp.com/terraform/language/functions/md5 md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits. |
merge | {@link https://developer.hashicorp.com/terraform/language/functions/merge merge} takes an arbitrary number of maps or objects, and returns a single map or object that contains a merged set of elements from all arguments. |
min | {@link https://developer.hashicorp.com/terraform/language/functions/min min} takes one or more numbers and returns the smallest number from the set. |
nonsensitive | {@link https://developer.hashicorp.com/terraform/language/functions/nonsensitive nonsensitive} takes a sensitive value and returns a copy of that value with the sensitive marking removed, thereby exposing the sensitive value. |
one | {@link https://developer.hashicorp.com/terraform/language/functions/one one} takes a list, set, or tuple value with either zero or one elements. If the collection is empty, one returns null . Otherwise, one returns the first element. If there are two or more elements then one will return an error. |
parseint | {@link https://developer.hashicorp.com/terraform/language/functions/parseint parseint} parses the given string as a representation of an integer in the specified base and returns the resulting number. The base must be between 2 and 62 inclusive. |
pathexpand | {@link https://developer.hashicorp.com/terraform/language/functions/pathexpand pathexpand} takes a filesystem path that might begin with a ~ segment, and if so it replaces that segment with the current user's home directory path. |
plantimestamp | {@link https://developer.hashicorp.com/terraform/language/functions/plantimestamp plantimestamp} returns a UTC timestamp string in RFC 3339 format, fixed to a constant time representing the time of the plan. |
pow | {@link https://developer.hashicorp.com/terraform/language/functions/pow pow} calculates an exponent, by raising its first argument to the power of the second argument. |
regex | {@link https://developer.hashicorp.com/terraform/language/functions/regex regex} applies a regular expression to a string and returns the matching substrings. |
regexall | {@link https://developer.hashicorp.com/terraform/language/functions/regexall regexall} applies a regular expression to a string and returns a list of all matches. |
replace | {@link https://developer.hashicorp.com/terraform/language/functions/replace replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string. |
reverse | {@link https://developer.hashicorp.com/terraform/language/functions/reverse reverse} takes a sequence and produces a new sequence of the same length with all of the same elements as the given sequence but in reverse order. |
rsadecrypt | {@link https://developer.hashicorp.com/terraform/language/functions/rsadecrypt rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext. |
sensitive | {@link https://developer.hashicorp.com/terraform/language/functions/sensitive sensitive} takes any value and returns a copy of it marked so that Terraform will treat it as sensitive, with the same meaning and behavior as for sensitive input variables. |
setintersection | The {@link https://developer.hashicorp.com/terraform/language/functions/setintersection setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. In other words, it computes the intersection of the sets. |
setproduct | The {@link https://developer.hashicorp.com/terraform/language/functions/setproduct setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product. |
setsubtract | The {@link https://developer.hashicorp.com/terraform/language/functions/setsubtract setsubtract} function returns a new set containing the elements from the first set that are not present in the second set. In other words, it computes the relative complement of the second set. |
setunion | The {@link https://developer.hashicorp.com/terraform/language/functions/setunion setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets. In other words, it computes the union of the sets. |
sha1 | {@link https://developer.hashicorp.com/terraform/language/functions/sha1 sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits. |
sha256 | {@link https://developer.hashicorp.com/terraform/language/functions/sha256 sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits. |
sha512 | {@link https://developer.hashicorp.com/terraform/language/functions/sha512 sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits. |
signum | {@link https://developer.hashicorp.com/terraform/language/functions/signum signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign. |
slice | {@link https://developer.hashicorp.com/terraform/language/functions/slice slice} extracts some consecutive elements from within a list. |
sort | {@link https://developer.hashicorp.com/terraform/language/functions/sort sort} takes a list of strings and returns a new list with those strings sorted lexicographically. |
split | {@link https://developer.hashicorp.com/terraform/language/functions/split split} produces a list by dividing a given string at all occurrences of a given separator. |
startswith | {@link https://developer.hashicorp.com/terraform/language/functions/startswith startswith} takes two values: a string to check and a prefix string. The function returns true if the string begins with that exact prefix. |
strcontains | {@link https://developer.hashicorp.com/terraform/language/functions/strcontains strcontains} takes two values: a string to check and an expected substring. The function returns true if the string has the substring contained within it. |
strrev | {@link https://developer.hashicorp.com/terraform/language/functions/strrev strrev} reverses the characters in a string. Note that the characters are treated as Unicode characters (in technical terms, Unicode grapheme cluster boundaries are respected). |
substr | {@link https://developer.hashicorp.com/terraform/language/functions/substr substr} extracts a substring from a given string by offset and (maximum) length. |
sum | {@link https://developer.hashicorp.com/terraform/language/functions/sum sum} takes a list or set of numbers and returns the sum of those numbers. |
templatefile | {@link https://developer.hashicorp.com/terraform/language/functions/templatefile templatefile} reads the file at the given path and renders its content as a template using a supplied set of template variables. |
textdecodebase64 | {@link https://developer.hashicorp.com/terraform/language/functions/textdecodebase64 textdecodebase64} function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding. |
textencodebase64 | {@link https://developer.hashicorp.com/terraform/language/functions/textencodebase64 textencodebase64} encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters. |
timeadd | {@link https://developer.hashicorp.com/terraform/language/functions/timeadd timeadd} adds a duration to a timestamp, returning a new timestamp. |
timecmp | {@link https://developer.hashicorp.com/terraform/language/functions/timecmp timecmp} compares two timestamps and returns a number that represents the ordering of the instants those timestamps represent. |
timestamp | {@link https://developer.hashicorp.com/terraform/language/functions/timestamp timestamp} returns a UTC timestamp string in RFC 3339 format. |
title | {@link https://developer.hashicorp.com/terraform/language/functions/title title} converts the first letter of each word in the given string to uppercase. |
tobool | {@link https://developer.hashicorp.com/terraform/language/functions/tobool tobool} converts its argument to a boolean value. |
tolist | {@link https://developer.hashicorp.com/terraform/language/functions/tolist tolist} converts its argument to a list value. |
tomap | {@link https://developer.hashicorp.com/terraform/language/functions/tomap tomap} converts its argument to a map value. |
tonumber | {@link https://developer.hashicorp.com/terraform/language/functions/tonumber tonumber} converts its argument to a number value. |
toset | {@link https://developer.hashicorp.com/terraform/language/functions/toset toset} converts its argument to a set value. |
tostring | {@link https://developer.hashicorp.com/terraform/language/functions/tostring tostring} converts its argument to a string value. |
transpose | {@link https://developer.hashicorp.com/terraform/language/functions/transpose transpose} takes a map of lists of strings and swaps the keys and values to produce a new map of lists of strings. |
trim | {@link https://developer.hashicorp.com/terraform/language/functions/trim trim} removes the specified set of characters from the start and end of the given string. |
trimprefix | {@link https://developer.hashicorp.com/terraform/language/functions/trimprefix trimprefix} removes the specified prefix from the start of the given string. If the string does not start with the prefix, the string is returned unchanged. |
trimspace | {@link https://developer.hashicorp.com/terraform/language/functions/trimspace trimspace} removes any space characters from the start and end of the given string. |
trimsuffix | {@link https://developer.hashicorp.com/terraform/language/functions/trimsuffix trimsuffix} removes the specified suffix from the end of the given string. |
try | {@link https://developer.hashicorp.com/terraform/language/functions/try try} evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors. |
upper | {@link https://developer.hashicorp.com/terraform/language/functions/upper upper} converts all cased letters in the given string to uppercase. |
urlencode | {@link https://developer.hashicorp.com/terraform/language/functions/urlencode urlencode} applies URL encoding to a given string. |
uuid | {@link https://developer.hashicorp.com/terraform/language/functions/uuid uuid} generates a unique identifier string. |
uuidv5 | {@link https://developer.hashicorp.com/terraform/language/functions/uuidv5 uuidv5} generates a name-based UUID, as described in RFC 4122 section 4.3, also known as a "version 5" UUID. |
values | {@link https://developer.hashicorp.com/terraform/language/functions/values values} takes a map and returns a list containing the values of the elements in that map. |
yamldecode | {@link https://developer.hashicorp.com/terraform/language/functions/yamldecode yamldecode} parses a string as a subset of YAML, and produces a representation of its value. |
yamlencode | {@link https://developer.hashicorp.com/terraform/language/functions/yamlencode yamlencode} encodes a given value to a string using YAML 1.2 block syntax. |
zipmap | {@link https://developer.hashicorp.com/terraform/language/functions/zipmap zipmap} constructs a map from a list of keys and a corresponding list of values. |
abs
{@link https://developer.hashicorp.com/terraform/language/functions/abs abs} returns the absolute value of the given number. In other words, if the number is zero or positive then it is returned as-is, but if it is negative then it is multiplied by -1 to make it positive before returning it.
num
Required
- Type: number
abspath
{@link https://developer.hashicorp.com/terraform/language/functions/abspath abspath} takes a string containing a filesystem path and converts it to an absolute path. That is, if the path is not absolute, it will be joined with the current working directory.
path
Required
- Type: string
alltrue
{@link https://developer.hashicorp.com/terraform/language/functions/alltrue alltrue} returns true
if all elements in a given collection are true
or "true"
. It also returns true
if the collection is empty.
list
Required
- Type: any[]
anytrue
{@link https://developer.hashicorp.com/terraform/language/functions/anytrue anytrue} returns true
if any element in a given collection is true
or "true"
. It also returns false
if the collection is empty.
list
Required
- Type: any[]
base64decode
{@link https://developer.hashicorp.com/terraform/language/functions/base64decode base64decode} takes a string containing a Base64 character sequence and returns the original string.
str
Required
- Type: string
base64encode
{@link https://developer.hashicorp.com/terraform/language/functions/base64encode base64encode} applies Base64 encoding to a string.
str
Required
- Type: string
base64gzip
{@link https://developer.hashicorp.com/terraform/language/functions/base64gzip base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding.
str
Required
- Type: string
base64sha256
{@link https://developer.hashicorp.com/terraform/language/functions/base64sha256 base64sha256} computes the SHA256 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha256("test"))
since sha256()
returns hexadecimal representation.
str
Required
- Type: string
base64sha512
{@link https://developer.hashicorp.com/terraform/language/functions/base64sha512 base64sha512} computes the SHA512 hash of a given string and encodes it with Base64. This is not equivalent to base64encode(sha512("test"))
since sha512()
returns hexadecimal representation.
str
Required
- Type: string
basename
{@link https://developer.hashicorp.com/terraform/language/functions/basename basename} takes a string containing a filesystem path and removes all except the last portion from it.
path
Required
- Type: string
can
{@link https://developer.hashicorp.com/terraform/language/functions/can can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors.
expression
Required
- Type: any
ceil
{@link https://developer.hashicorp.com/terraform/language/functions/ceil ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction.
num
Required
- Type: number
chomp
{@link https://developer.hashicorp.com/terraform/language/functions/chomp chomp} removes newline characters at the end of a string.
str
Required
- Type: string
chunklist
{@link https://developer.hashicorp.com/terraform/language/functions/chunklist chunklist} splits a single list into fixed-size chunks, returning a list of lists.
list
Required
- Type: any[]
size
Required
- Type: number
cidrhost
{@link https://developer.hashicorp.com/terraform/language/functions/cidrhost cidrhost} calculates a full host IP address for a given host number within a given IP network address prefix.
prefix
Required
- Type: string
hostnum
Required
- Type: number
cidrnetmask
{@link https://developer.hashicorp.com/terraform/language/functions/cidrnetmask cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address.
prefix
Required
- Type: string
cidrsubnet
{@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnet cidrsubnet} calculates a subnet address within given IP network address prefix.
prefix
Required
- Type: string
newbits
Required
- Type: number
netnum
Required
- Type: number
cidrsubnets
{@link https://developer.hashicorp.com/terraform/language/functions/cidrsubnets cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix.
prefix
Required
- Type: string
newbits
Required
- Type: number[]
coalesce
{@link https://developer.hashicorp.com/terraform/language/functions/coalesce coalesce} takes any number of arguments and returns the first one that isn't null or an empty string.
vals
Required
- Type: any[]
coalescelist
{@link https://developer.hashicorp.com/terraform/language/functions/coalescelist coalescelist} takes any number of list arguments and returns the first one that isn't empty.
vals
Required
- Type: any[]
compact
{@link https://developer.hashicorp.com/terraform/language/functions/compact compact} takes a list of strings and returns a new list with any empty string elements removed.
list
Required
- Type: string[]
concat
{@link https://developer.hashicorp.com/terraform/language/functions/concat concat} takes two or more lists and combines them into a single list.
seqs
Required
- Type: any[]
contains
{@link https://developer.hashicorp.com/terraform/language/functions/contains contains} determines whether a given list or set contains a given single value as one of its elements.
list
Required
- Type: any
value
Required
- Type: any
csvdecode
{@link https://developer.hashicorp.com/terraform/language/functions/csvdecode csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data.
str
Required
- Type: string
dirname
{@link https://developer.hashicorp.com/terraform/language/functions/dirname dirname} takes a string containing a filesystem path and removes the last portion from it.
path
Required
- Type: string
distinct
{@link https://developer.hashicorp.com/terraform/language/functions/distinct distinct} takes a list and returns a new list with any duplicate elements removed.
list
Required
- Type: any[]
element
{@link https://developer.hashicorp.com/terraform/language/functions/element element} retrieves a single element from a list.
list
Required
- Type: any
index
Required
- Type: number
endswith
{@link https://developer.hashicorp.com/terraform/language/functions/endswith endswith} takes two values: a string to check and a suffix string. The function returns true if the first string ends with that exact suffix.
str
Required
- Type: string
suffix
Required
- Type: string
file
{@link https://developer.hashicorp.com/terraform/language/functions/file file} reads the contents of a file at the given path and returns them as a string.
path
Required
- Type: string
filebase64
{@link https://developer.hashicorp.com/terraform/language/functions/filebase64 filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string.
path
Required
- Type: string
filebase64sha256
{@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha256 filebase64sha256} is a variant of base64sha256
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
filebase64sha512
{@link https://developer.hashicorp.com/terraform/language/functions/filebase64sha512 filebase64sha512} is a variant of base64sha512
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
fileexists
{@link https://developer.hashicorp.com/terraform/language/functions/fileexists fileexists} determines whether a file exists at a given path.
path
Required
- Type: string
filemd5
{@link https://developer.hashicorp.com/terraform/language/functions/filemd5 filemd5} is a variant of md5
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
fileset
{@link https://developer.hashicorp.com/terraform/language/functions/fileset fileset} enumerates a set of regular file names given a path and pattern. The path is automatically removed from the resulting set of file names and any result still containing path separators always returns forward slash (/
) as the path separator for cross-system compatibility.
path
Required
- Type: string
pattern
Required
- Type: string
filesha1
{@link https://developer.hashicorp.com/terraform/language/functions/filesha1 filesha1} is a variant of sha1
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
filesha256
{@link https://developer.hashicorp.com/terraform/language/functions/filesha256 filesha256} is a variant of sha256
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
filesha512
{@link https://developer.hashicorp.com/terraform/language/functions/filesha512 filesha512} is a variant of sha512
that hashes the contents of a given file rather than a literal string.
path
Required
- Type: string
flatten
{@link https://developer.hashicorp.com/terraform/language/functions/flatten flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents.
list
Required
- Type: any
floor
{@link https://developer.hashicorp.com/terraform/language/functions/floor floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction.
num
Required
- Type: number
format
The {@link https://developer.hashicorp.com/terraform/language/functions/format format} function produces a string by formatting a number of other values according to a specification string. It is similar to the printf
function in C, and other similar functions in other programming languages.
format
Required
- Type: string
args
Required
- Type: any[]
formatdate
{@link https://developer.hashicorp.com/terraform/language/functions/formatdate formatdate} converts a timestamp into a different time format.
format
Required
- Type: string
time
Required
- Type: string
formatlist
{@link https://developer.hashicorp.com/terraform/language/functions/formatlist formatlist} produces a list of strings by formatting a number of other values according to a specification string.
format
Required
- Type: string
args
Required
- Type: any[]
indent
{@link https://developer.hashicorp.com/terraform/language/functions/indent indent} adds a given number of spaces to the beginnings of all but the first line in a given multi-line string.
spaces
Required
- Type: number
str
Required
- Type: string
index
{@link https://developer.hashicorp.com/terraform/language/functions/index index} finds the element index for a given value in a list.
list
Required
- Type: any
value
Required
- Type: any
jsondecode
{@link https://developer.hashicorp.com/terraform/language/functions/jsondecode jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string.
str
Required
- Type: string
jsonencode
{@link https://developer.hashicorp.com/terraform/language/functions/jsonencode jsonencode} encodes a given value to a string using JSON syntax.
val
Required
- Type: any
keys
{@link https://developer.hashicorp.com/terraform/language/functions/keys keys} takes a map and returns a list containing the keys from that map.
inputMap
Required
- Type: any
lengthOf
{@link https://developer.hashicorp.com/terraform/language/functions/length length} determines the length of a given list, map, or string.
value
Required
- Type: any
log
{@link https://developer.hashicorp.com/terraform/language/functions/log log} returns the logarithm of a given number in a given base.
num
Required
- Type: number
base
Required
- Type: number
lower
{@link https://developer.hashicorp.com/terraform/language/functions/lower lower} converts all cased letters in the given string to lowercase.
str
Required
- Type: string
matchkeys
{@link https://developer.hashicorp.com/terraform/language/functions/matchkeys matchkeys} constructs a new list by taking a subset of elements from one list whose indexes match the corresponding indexes of values in another list.
values
Required
- Type: any[]
keys
Required
- Type: any[]
searchset
Required
- Type: any[]
max
{@link https://developer.hashicorp.com/terraform/language/functions/max max} takes one or more numbers and returns the greatest number from the set.
numbers
Required
- Type: number[]
md5
{@link https://developer.hashicorp.com/terraform/language/functions/md5 md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
merge
{@link https://developer.hashicorp.com/terraform/language/functions/merge merge} takes an arbitrary number of maps or objects, and returns a single map or object that contains a merged set of elements from all arguments.
maps
Required
- Type: any[]
min
{@link https://developer.hashicorp.com/terraform/language/functions/min min} takes one or more numbers and returns the smallest number from the set.
numbers
Required
- Type: number[]
nonsensitive
{@link https://developer.hashicorp.com/terraform/language/functions/nonsensitive nonsensitive} takes a sensitive value and returns a copy of that value with the sensitive marking removed, thereby exposing the sensitive value.
value
Required
- Type: any
one
{@link https://developer.hashicorp.com/terraform/language/functions/one one} takes a list, set, or tuple value with either zero or one elements. If the collection is empty, one
returns null
. Otherwise, one
returns the first element. If there are two or more elements then one
will return an error.
list
Required
- Type: any
parseint
{@link https://developer.hashicorp.com/terraform/language/functions/parseint parseint} parses the given string as a representation of an integer in the specified base and returns the resulting number. The base must be between 2 and 62 inclusive.
number
Required
- Type: any
base
Required
- Type: number
pathexpand
{@link https://developer.hashicorp.com/terraform/language/functions/pathexpand pathexpand} takes a filesystem path that might begin with a ~
segment, and if so it replaces that segment with the current user's home directory path.
path
Required
- Type: string
plantimestamp
{@link https://developer.hashicorp.com/terraform/language/functions/plantimestamp plantimestamp} returns a UTC timestamp string in RFC 3339 format, fixed to a constant time representing the time of the plan.
pow
{@link https://developer.hashicorp.com/terraform/language/functions/pow pow} calculates an exponent, by raising its first argument to the power of the second argument.
num
Required
- Type: number
power
Required
- Type: number
regex
{@link https://developer.hashicorp.com/terraform/language/functions/regex regex} applies a regular expression to a string and returns the matching substrings.
pattern
Required
- Type: string
str
Required
- Type: string
regexall
{@link https://developer.hashicorp.com/terraform/language/functions/regexall regexall} applies a regular expression to a string and returns a list of all matches.
pattern
Required
- Type: string
str
Required
- Type: string
replace
{@link https://developer.hashicorp.com/terraform/language/functions/replace replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string.
str
Required
- Type: string
substr
Required
- Type: string
replace
Required
- Type: string
reverse
{@link https://developer.hashicorp.com/terraform/language/functions/reverse reverse} takes a sequence and produces a new sequence of the same length with all of the same elements as the given sequence but in reverse order.
list
Required
- Type: any
rsadecrypt
{@link https://developer.hashicorp.com/terraform/language/functions/rsadecrypt rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext.
ciphertext
Required
- Type: string
privatekey
Required
- Type: string
sensitive
{@link https://developer.hashicorp.com/terraform/language/functions/sensitive sensitive} takes any value and returns a copy of it marked so that Terraform will treat it as sensitive, with the same meaning and behavior as for sensitive input variables.
value
Required
- Type: any
setintersection
The {@link https://developer.hashicorp.com/terraform/language/functions/setintersection setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. In other words, it computes the intersection of the sets.
first_set
Required
- Type: any[]
other_sets
Required
- Type: any[][]
setproduct
The {@link https://developer.hashicorp.com/terraform/language/functions/setproduct setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product.
sets
Required
- Type: any[]
setsubtract
The {@link https://developer.hashicorp.com/terraform/language/functions/setsubtract setsubtract} function returns a new set containing the elements from the first set that are not present in the second set. In other words, it computes the relative complement of the second set.
a
Required
- Type: any[]
b
Required
- Type: any[]
setunion
The {@link https://developer.hashicorp.com/terraform/language/functions/setunion setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets. In other words, it computes the union of the sets.
first_set
Required
- Type: any[]
other_sets
Required
- Type: any[][]
sha1
{@link https://developer.hashicorp.com/terraform/language/functions/sha1 sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
sha256
{@link https://developer.hashicorp.com/terraform/language/functions/sha256 sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
sha512
{@link https://developer.hashicorp.com/terraform/language/functions/sha512 sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits.
str
Required
- Type: string
signum
{@link https://developer.hashicorp.com/terraform/language/functions/signum signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign.
num
Required
- Type: number
slice
{@link https://developer.hashicorp.com/terraform/language/functions/slice slice} extracts some consecutive elements from within a list.
list
Required
- Type: any
start_index
Required
- Type: number
end_index
Required
- Type: number
sort
{@link https://developer.hashicorp.com/terraform/language/functions/sort sort} takes a list of strings and returns a new list with those strings sorted lexicographically.
list
Required
- Type: string[]
split
{@link https://developer.hashicorp.com/terraform/language/functions/split split} produces a list by dividing a given string at all occurrences of a given separator.
separator
Required
- Type: string
str
Required
- Type: string
startswith
{@link https://developer.hashicorp.com/terraform/language/functions/startswith startswith} takes two values: a string to check and a prefix string. The function returns true if the string begins with that exact prefix.
str
Required
- Type: string
prefix
Required
- Type: string
strcontains
{@link https://developer.hashicorp.com/terraform/language/functions/strcontains strcontains} takes two values: a string to check and an expected substring. The function returns true if the string has the substring contained within it.
str
Required
- Type: string
substr
Required
- Type: string
strrev
{@link https://developer.hashicorp.com/terraform/language/functions/strrev strrev} reverses the characters in a string. Note that the characters are treated as Unicode characters (in technical terms, Unicode grapheme cluster boundaries are respected).
str
Required
- Type: string
substr
{@link https://developer.hashicorp.com/terraform/language/functions/substr substr} extracts a substring from a given string by offset and (maximum) length.
str
Required
- Type: string
offset
Required
- Type: number
length
Required
- Type: number
sum
{@link https://developer.hashicorp.com/terraform/language/functions/sum sum} takes a list or set of numbers and returns the sum of those numbers.
list
Required
- Type: any
templatefile
{@link https://developer.hashicorp.com/terraform/language/functions/templatefile templatefile} reads the file at the given path and renders its content as a template using a supplied set of template variables.
path
Required
- Type: string
vars
Required
- Type: any
textdecodebase64
{@link https://developer.hashicorp.com/terraform/language/functions/textdecodebase64 textdecodebase64} function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding.
source
Required
- Type: string
encoding
Required
- Type: string
textencodebase64
{@link https://developer.hashicorp.com/terraform/language/functions/textencodebase64 textencodebase64} encodes the unicode characters in a given string using a specified character encoding, returning the result base64 encoded because Terraform language strings are always sequences of unicode characters.
str
Required
- Type: string
encoding
Required
- Type: string
timeadd
{@link https://developer.hashicorp.com/terraform/language/functions/timeadd timeadd} adds a duration to a timestamp, returning a new timestamp.
timestamp
Required
- Type: string
duration
Required
- Type: string
timecmp
{@link https://developer.hashicorp.com/terraform/language/functions/timecmp timecmp} compares two timestamps and returns a number that represents the ordering of the instants those timestamps represent.
timestamp_a
Required
- Type: string
timestamp_b
Required
- Type: string
timestamp
{@link https://developer.hashicorp.com/terraform/language/functions/timestamp timestamp} returns a UTC timestamp string in RFC 3339 format.
title
{@link https://developer.hashicorp.com/terraform/language/functions/title title} converts the first letter of each word in the given string to uppercase.
str
Required
- Type: string
tobool
{@link https://developer.hashicorp.com/terraform/language/functions/tobool tobool} converts its argument to a boolean value.
v
Required
- Type: any
tolist
{@link https://developer.hashicorp.com/terraform/language/functions/tolist tolist} converts its argument to a list value.
v
Required
- Type: any
tomap
{@link https://developer.hashicorp.com/terraform/language/functions/tomap tomap} converts its argument to a map value.
v
Required
- Type: any
tonumber
{@link https://developer.hashicorp.com/terraform/language/functions/tonumber tonumber} converts its argument to a number value.
v
Required
- Type: any
toset
{@link https://developer.hashicorp.com/terraform/language/functions/toset toset} converts its argument to a set value.
v
Required
- Type: any
tostring
{@link https://developer.hashicorp.com/terraform/language/functions/tostring tostring} converts its argument to a string value.
v
Required
- Type: any
transpose
{@link https://developer.hashicorp.com/terraform/language/functions/transpose transpose} takes a map of lists of strings and swaps the keys and values to produce a new map of lists of strings.
values
Required
- Type: any
trim
{@link https://developer.hashicorp.com/terraform/language/functions/trim trim} removes the specified set of characters from the start and end of the given string.
str
Required
- Type: string
cutset
Required
- Type: string
trimprefix
{@link https://developer.hashicorp.com/terraform/language/functions/trimprefix trimprefix} removes the specified prefix from the start of the given string. If the string does not start with the prefix, the string is returned unchanged.
str
Required
- Type: string
prefix
Required
- Type: string
trimspace
{@link https://developer.hashicorp.com/terraform/language/functions/trimspace trimspace} removes any space characters from the start and end of the given string.
str
Required
- Type: string
trimsuffix
{@link https://developer.hashicorp.com/terraform/language/functions/trimsuffix trimsuffix} removes the specified suffix from the end of the given string.
str
Required
- Type: string
suffix
Required
- Type: string
try
{@link https://developer.hashicorp.com/terraform/language/functions/try try} evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors.
expressions
Required
- Type: any[]
upper
{@link https://developer.hashicorp.com/terraform/language/functions/upper upper} converts all cased letters in the given string to uppercase.
str
Required
- Type: string
urlencode
{@link https://developer.hashicorp.com/terraform/language/functions/urlencode urlencode} applies URL encoding to a given string.
str
Required
- Type: string
uuid
{@link https://developer.hashicorp.com/terraform/language/functions/uuid uuid} generates a unique identifier string.
uuidv5
{@link https://developer.hashicorp.com/terraform/language/functions/uuidv5 uuidv5} generates a name-based UUID, as described in RFC 4122 section 4.3, also known as a "version 5" UUID.
namespace
Required
- Type: string
name
Required
- Type: string
values
{@link https://developer.hashicorp.com/terraform/language/functions/values values} takes a map and returns a list containing the values of the elements in that map.
mapping
Required
- Type: any
yamldecode
{@link https://developer.hashicorp.com/terraform/language/functions/yamldecode yamldecode} parses a string as a subset of YAML, and produces a representation of its value.
src
Required
- Type: string
yamlencode
{@link https://developer.hashicorp.com/terraform/language/functions/yamlencode yamlencode} encodes a given value to a string using YAML 1.2 block syntax.
value
Required
- Type: any
zipmap
{@link https://developer.hashicorp.com/terraform/language/functions/zipmap zipmap} constructs a map from a list of keys and a corresponding list of values.
keys
Required
- Type: string[]
values
Required
- Type: any
Lazy
Lazily produce a value.
Can be used to return a string, list or numeric value whose actual value will only be calculated later, during synthesis.
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
anyValue | Produces a lazy token from an untyped value. |
listValue | Returns a list-ified token for a lazy value. |
numberValue | Returns a numberified token for a lazy value. |
stringValue | Returns a stringified token for a lazy value. |
anyValue
Produces a lazy token from an untyped value.
producer
Required
- Type: IAnyProducer
The lazy producer.
options
Optional
- Type: LazyAnyValueOptions
Options.
listValue
Returns a list-ified token for a lazy value.
producer
Required
- Type: IListProducer
The producer.
options
Optional
- Type: LazyListValueOptions
Options.
numberValue
Returns a numberified token for a lazy value.
producer
Required
- Type: INumberProducer
The producer.
stringValue
Returns a stringified token for a lazy value.
producer
Required
- Type: IStringProducer
The producer.
options
Optional
- Type: LazyStringValueOptions
Options.
LazyBase
- Implements: IResolvable
Initializers
Name | Type | Description |
---|
Methods
Name | Description |
---|---|
addPostProcessor | No description. |
resolve | Produce the Token's value at resolution time. |
toJSON | Turn this Token into JSON. |
toString | Return a string representation of this resolvable object. |
addPostProcessor
postProcessor
Required
- Type: IPostProcessor
resolve
Produce the Token's value at resolution time.
context
Required
- Type: IResolveContext
toJSON
Turn this Token into JSON.
Called automatically when JSON.stringify() is called on a Token.
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
ListTerraformIterator
Initializers
Name | Type | Description |
---|---|---|
list | string[] | IResolvable | number[] | boolean | IResolvable[] | No description. |
list
Required
- Type: string[] | IResolvable | number[] | boolean | IResolvable[]
Methods
Name | Description |
---|---|
dynamic | Creates a dynamic expression that can be used to loop over this iterator in a dynamic block. |
forExpressionForList | Creates a for expression that results in a list. |
forExpressionForMap | Creates a for expression that results in a map. |
getAny | No description. |
getAnyMap | No description. |
getBoolean | No description. |
getBooleanMap | No description. |
getList | No description. |
getMap | No description. |
getNumber | No description. |
getNumberList | No description. |
getNumberMap | No description. |
getString | No description. |
getStringMap | No description. |
keys | Creates a for expression that maps the iterators to its keys. |
pluckProperty | Creates a for expression that accesses the key on each element of the iterator. |
values | Creates a for expression that maps the iterators to its value in case it is a map. |
dynamic
Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
See https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-for-list-attributes
attributes
Required
- Type: {[ key: string ]: any}
forExpressionForList
Creates a for expression that results in a list.
This method allows you to create every possible for expression, but requires more knowledge about Terraform's for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true")
will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ]
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
expression
Required
- Type: string | IResolvable
The expression to use in the for mapping.
forExpressionForMap
Creates a for expression that results in a map.
This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true")
will result in { for key, val in var.myIteratorSource: key = > val.foo if val.bar == true }
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
keyExpression
Required
- Type: string | IResolvable
The expression to use as key in the for mapping.
valueExpression
Required
- Type: string | IResolvable
The expression to use as value in the for mapping.
getAny
attribute
Required
- Type: string
name of the property to retrieve.
getAnyMap
attribute
Required
- Type: string
name of the property to retrieve.
getBoolean
attribute
Required
- Type: string
name of the property to retrieve.
getBooleanMap
attribute
Required
- Type: string
name of the property to retrieve.
getList
attribute
Required
- Type: string
name of the property to retrieve.
getMap
attribute
Required
- Type: string
name of the property to retrieve.
getNumber
attribute
Required
- Type: string
name of the property to retrieve.
getNumberList
attribute
Required
- Type: string
name of the property to retrieve.
getNumberMap
attribute
Required
- Type: string
name of the property to retrieve.
getString
attribute
Required
- Type: string
name of the property to retrieve.
getStringMap
attribute
Required
- Type: string
name of the property to retrieve.
keys
Creates a for expression that maps the iterators to its keys.
For lists these would be the indices, for maps the keys.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
pluckProperty
Creates a for expression that accesses the key on each element of the iterator.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
property
Required
- Type: string
The property of the iterators values to map to.
values
Creates a for expression that maps the iterators to its value in case it is a map.
For lists these would stay the same.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
Static Functions
Name | Description |
---|---|
fromComplexList | Creates a new iterator from a complex list. |
fromDataSources | Creates a new iterator from a data source that has been created with the for_each argument. |
fromList | Creates a new iterator from a list. |
fromMap | Creates a new iterator from a map. |
fromResources | Creates a new iterator from a resource that has been created with the for_each argument. |
fromComplexList
Creates a new iterator from a complex list.
One example for this would be a list of maps. The list will be converted into a map with the mapKeyAttributeName as the key.
Example
list
Required
- Type: IResolvable | ComplexList | StringMapList | NumberMapList | BooleanMapList | AnyMapList
the list to iterate over.
mapKeyAttributeName
Required
- Type: string
the name of the attribute that should be used as the key in the map.
Visit https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-on-complex-lists for more information.
fromDataSources
Creates a new iterator from a data source that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
fromList
Creates a new iterator from a list.
list
Required
- Type: string[] | IResolvable | number[] | boolean | IResolvable[]
fromMap
Creates a new iterator from a map.
map
Required
- Type: ComplexMap | {[ key: string ]: any} | {[ key: string ]: string} | {[ key: string ]: number} | {[ key: string ]: boolean}
fromResources
Creates a new iterator from a resource that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
Properties
Name | Type | Description |
---|---|---|
key | any | Returns the currently entry in the list or set that is being iterated over. |
value | any | Returns the value of the current item iterated over. |
key
Required
- Type: any
Returns the currently entry in the list or set that is being iterated over.
For lists this is the same as iterator.value
. If you need the index,
use count via TerraformCount
:
https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-count
value
Required
- Type: any
Returns the value of the current item iterated over.
Manifest
- Implements: IManifest
Initializers
Name | Type | Description |
---|---|---|
version | string | No description. |
outdir | string | No description. |
hclOutput | boolean | No description. |
version
Required
- Type: string
outdir
Required
- Type: string
hclOutput
Required
- Type: boolean
Methods
Name | Description |
---|---|
buildManifest | No description. |
forStack | No description. |
writeToFile | No description. |
buildManifest
forStack
stack
Required
- Type: TerraformStack
writeToFile
Properties
Name | Type | Description |
---|---|---|
hclOutput | boolean | No description. |
outdir | string | No description. |
stackFileName | string | No description. |
stacks | {[ key: string ]: StackManifest} | No description. |
version | string | No description. |
hclOutput
Required
- Type: boolean
outdir
Required
- Type: string
stackFileName
Required
- Type: string
stacks
Required
- Type: {[ key: string ]: StackManifest}
version
Required
- Type: string
Constants
Name | Type | Description |
---|---|---|
fileName | string | No description. |
stackMetadataPath | string | No description. |
stacksFolder | string | No description. |
fileName
Required
- Type: string
stackMetadataPath
Required
- Type: string
stacksFolder
Required
- Type: string
MapList
- Implements: ITerraformAddressable, IInterpolatingParent, IResolvable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
MapTerraformIterator
Initializers
Name | Type | Description |
---|---|---|
map | AnyMap | StringMap | NumberMap | BooleanMap | ComplexMap | {[ key: string ]: any} | {[ key: string ]: string} | {[ key: string ]: number} | No description. |
map
Required
- Type: AnyMap | StringMap | NumberMap | BooleanMap | ComplexMap | {[ key: string ]: any} | {[ key: string ]: string} | {[ key: string ]: number}
Methods
Name | Description |
---|---|
dynamic | Creates a dynamic expression that can be used to loop over this iterator in a dynamic block. |
forExpressionForList | Creates a for expression that results in a list. |
forExpressionForMap | Creates a for expression that results in a map. |
getAny | No description. |
getAnyMap | No description. |
getBoolean | No description. |
getBooleanMap | No description. |
getList | No description. |
getMap | No description. |
getNumber | No description. |
getNumberList | No description. |
getNumberMap | No description. |
getString | No description. |
getStringMap | No description. |
keys | Creates a for expression that maps the iterators to its keys. |
pluckProperty | Creates a for expression that accesses the key on each element of the iterator. |
values | Creates a for expression that maps the iterators to its value in case it is a map. |
dynamic
Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
See https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-for-list-attributes
attributes
Required
- Type: {[ key: string ]: any}
forExpressionForList
Creates a for expression that results in a list.
This method allows you to create every possible for expression, but requires more knowledge about Terraform's for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true")
will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ]
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
expression
Required
- Type: string | IResolvable
The expression to use in the for mapping.
forExpressionForMap
Creates a for expression that results in a map.
This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true")
will result in { for key, val in var.myIteratorSource: key = > val.foo if val.bar == true }
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
keyExpression
Required
- Type: string | IResolvable
The expression to use as key in the for mapping.
valueExpression
Required
- Type: string | IResolvable
The expression to use as value in the for mapping.
getAny
attribute
Required
- Type: string
name of the property to retrieve.
getAnyMap
attribute
Required
- Type: string
name of the property to retrieve.
getBoolean
attribute
Required
- Type: string
name of the property to retrieve.
getBooleanMap
attribute
Required
- Type: string
name of the property to retrieve.
getList
attribute
Required
- Type: string
name of the property to retrieve.
getMap
attribute
Required
- Type: string
name of the property to retrieve.
getNumber
attribute
Required
- Type: string
name of the property to retrieve.
getNumberList
attribute
Required
- Type: string
name of the property to retrieve.
getNumberMap
attribute
Required
- Type: string
name of the property to retrieve.
getString
attribute
Required
- Type: string
name of the property to retrieve.
getStringMap
attribute
Required
- Type: string
name of the property to retrieve.
keys
Creates a for expression that maps the iterators to its keys.
For lists these would be the indices, for maps the keys.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
pluckProperty
Creates a for expression that accesses the key on each element of the iterator.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
property
Required
- Type: string
The property of the iterators values to map to.
values
Creates a for expression that maps the iterators to its value in case it is a map.
For lists these would stay the same.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
Static Functions
Name | Description |
---|---|
fromComplexList | Creates a new iterator from a complex list. |
fromDataSources | Creates a new iterator from a data source that has been created with the for_each argument. |
fromList | Creates a new iterator from a list. |
fromMap | Creates a new iterator from a map. |
fromResources | Creates a new iterator from a resource that has been created with the for_each argument. |
fromComplexList
Creates a new iterator from a complex list.
One example for this would be a list of maps. The list will be converted into a map with the mapKeyAttributeName as the key.
Example
list
Required
- Type: IResolvable | ComplexList | StringMapList | NumberMapList | BooleanMapList | AnyMapList
the list to iterate over.
mapKeyAttributeName
Required
- Type: string
the name of the attribute that should be used as the key in the map.
Visit https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-on-complex-lists for more information.
fromDataSources
Creates a new iterator from a data source that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
fromList
Creates a new iterator from a list.
list
Required
- Type: string[] | IResolvable | number[] | boolean | IResolvable[]
fromMap
Creates a new iterator from a map.
map
Required
- Type: ComplexMap | {[ key: string ]: any} | {[ key: string ]: string} | {[ key: string ]: number} | {[ key: string ]: boolean}
fromResources
Creates a new iterator from a resource that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
Properties
Name | Type | Description |
---|---|---|
key | string | Returns the key of the current entry in the map that is being iterated over. |
value | any | Returns the value of the current item iterated over. |
key
Required
- Type: string
Returns the key of the current entry in the map that is being iterated over.
value
Required
- Type: any
Returns the value of the current item iterated over.
MigrateIds
- Implements: IAspect
For migrating past 0.17 where the feature flag for the old id generation logic was removed after being deprecated since 0.15.
Initializers
Name | Type | Description |
---|
Methods
Name | Description |
---|---|
visit | All aspects can visit an IConstruct. |
visit
All aspects can visit an IConstruct.
node
Required
- Type: constructs.IConstruct
NamedCloudWorkspace
The name of a single Terraform Cloud workspace.
You will only be able to use the workspace specified in the configuration with this working directory, and cannot manage workspaces from the CLI (e.g. terraform workspace select or terraform workspace new).
Initializers
name
Required
- Type: string
project
Optional
- Type: string
Methods
Name | Description |
---|---|
toTerraform | No description. |
toHclTerraform | No description. |
toTerraform
toHclTerraform
Properties
name
Required
- Type: string
project
Optional
- Type: string
NamedRemoteWorkspace
- Implements: IRemoteWorkspace
Initializers
Name | Type | Description |
---|---|---|
name | string | No description. |
name
Required
- Type: string
Properties
Name | Type | Description |
---|---|---|
name | string | No description. |
name
Required
- Type: string
NumberListList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
allWithMapKey | Creating an iterator for this complex list. |
computeFqn | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
allWithMapKey
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
mapKeyAttributeName
Required
- Type: string
computeFqn
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
NumberListMap
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
key
Required
- Type: string
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
NumberMap
- Implements: ITerraformAddressable, IResolvable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
lookup | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
lookup
key
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
NumberMapList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
Op
This class contains static functions for all arithmetical and logical operators in the Terraform configuration language.
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
add | Renders left + right. |
and | Renders left && right. |
div | Renders left / right. |
eq | Renders left == right. |
gt | Renders left > right. |
gte | Renders left >= right. |
lt | Renders left < right. |
lte | Renders left < = right. |
mod | Renders left % right. |
mul | Renders left * right. |
negate | Renders -expression. |
neq | Renders left != right. |
not | Renders !expression. |
or | Renders left || right. |
sub | Renders left - right. |
add
Renders left + right.
left
Required
- Type: any
right
Required
- Type: any
and
Renders left && right.
left
Required
- Type: any
right
Required
- Type: any
div
Renders left / right.
left
Required
- Type: any
right
Required
- Type: any
eq
Renders left == right.
left
Required
- Type: any
right
Required
- Type: any
gt
Renders left > right.
left
Required
- Type: any
right
Required
- Type: any
gte
Renders left >= right.
left
Required
- Type: any
right
Required
- Type: any
lt
Renders left < right.
left
Required
- Type: any
right
Required
- Type: any
lte
Renders left < = right.
left
Required
- Type: any
right
Required
- Type: any
mod
Renders left % right.
left
Required
- Type: any
right
Required
- Type: any
mul
Renders left * right.
left
Required
- Type: any
right
Required
- Type: any
negate
Renders -expression.
expression
Required
- Type: any
neq
Renders left != right.
left
Required
- Type: any
right
Required
- Type: any
not
Renders !expression.
expression
Required
- Type: any
or
Renders left || right.
left
Required
- Type: any
right
Required
- Type: any
sub
Renders left - right.
left
Required
- Type: any
right
Required
- Type: any
PrefixedRemoteWorkspaces
- Implements: IRemoteWorkspace
Initializers
Name | Type | Description |
---|---|---|
prefix | string | No description. |
prefix
Required
- Type: string
Properties
Name | Type | Description |
---|---|---|
prefix | string | No description. |
prefix
Required
- Type: string
ResourceTerraformIterator
Initializers
Name | Type | Description |
---|---|---|
element | ITerraformResource | No description. |
element
Required
- Type: ITerraformResource
Methods
Name | Description |
---|---|
dynamic | Creates a dynamic expression that can be used to loop over this iterator in a dynamic block. |
forExpressionForList | Creates a for expression that results in a list. |
forExpressionForMap | Creates a for expression that results in a map. |
getAny | No description. |
getAnyMap | No description. |
getBoolean | No description. |
getBooleanMap | No description. |
getList | No description. |
getMap | No description. |
getNumber | No description. |
getNumberList | No description. |
getNumberMap | No description. |
getString | No description. |
getStringMap | No description. |
keys | Creates a for expression that maps the iterators to its keys. |
pluckProperty | Creates a for expression that accesses the key on each element of the iterator. |
values | Creates a for expression that maps the iterators to its value in case it is a map. |
dynamic
Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
See https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-for-list-attributes
attributes
Required
- Type: {[ key: string ]: any}
forExpressionForList
Creates a for expression that results in a list.
This method allows you to create every possible for expression, but requires more knowledge about Terraform's for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true")
will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ]
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
expression
Required
- Type: string | IResolvable
The expression to use in the for mapping.
forExpressionForMap
Creates a for expression that results in a map.
This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true")
will result in { for key, val in var.myIteratorSource: key = > val.foo if val.bar == true }
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
keyExpression
Required
- Type: string | IResolvable
The expression to use as key in the for mapping.
valueExpression
Required
- Type: string | IResolvable
The expression to use as value in the for mapping.
getAny
attribute
Required
- Type: string
name of the property to retrieve.
getAnyMap
attribute
Required
- Type: string
name of the property to retrieve.
getBoolean
attribute
Required
- Type: string
name of the property to retrieve.
getBooleanMap
attribute
Required
- Type: string
name of the property to retrieve.
getList
attribute
Required
- Type: string
name of the property to retrieve.
getMap
attribute
Required
- Type: string
name of the property to retrieve.
getNumber
attribute
Required
- Type: string
name of the property to retrieve.
getNumberList
attribute
Required
- Type: string
name of the property to retrieve.
getNumberMap
attribute
Required
- Type: string
name of the property to retrieve.
getString
attribute
Required
- Type: string
name of the property to retrieve.
getStringMap
attribute
Required
- Type: string
name of the property to retrieve.
keys
Creates a for expression that maps the iterators to its keys.
For lists these would be the indices, for maps the keys.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
pluckProperty
Creates a for expression that accesses the key on each element of the iterator.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
property
Required
- Type: string
The property of the iterators values to map to.
values
Creates a for expression that maps the iterators to its value in case it is a map.
For lists these would stay the same.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
Static Functions
Name | Description |
---|---|
fromComplexList | Creates a new iterator from a complex list. |
fromDataSources | Creates a new iterator from a data source that has been created with the for_each argument. |
fromList | Creates a new iterator from a list. |
fromMap | Creates a new iterator from a map. |
fromResources | Creates a new iterator from a resource that has been created with the for_each argument. |
fromComplexList
Creates a new iterator from a complex list.
One example for this would be a list of maps. The list will be converted into a map with the mapKeyAttributeName as the key.
Example
list
Required
- Type: IResolvable | ComplexList | StringMapList | NumberMapList | BooleanMapList | AnyMapList
the list to iterate over.
mapKeyAttributeName
Required
- Type: string
the name of the attribute that should be used as the key in the map.
Visit https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-on-complex-lists for more information.
fromDataSources
Creates a new iterator from a data source that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
fromList
Creates a new iterator from a list.
list
Required
- Type: string[] | IResolvable | number[] | boolean | IResolvable[]
fromMap
Creates a new iterator from a map.
map
Required
- Type: ComplexMap | {[ key: string ]: any} | {[ key: string ]: string} | {[ key: string ]: number} | {[ key: string ]: boolean}
fromResources
Creates a new iterator from a resource that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
Properties
Name | Type | Description |
---|---|---|
key | any | Returns the current entry in the list or set that is being iterated over. |
value | any | Returns the value of the current item iterated over. |
key
Required
- Type: any
Returns the current entry in the list or set that is being iterated over.
For lists this is the same as iterator.value
. If you need the index,
use count via TerraformCount
:
https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-count
value
Required
- Type: any
Returns the value of the current item iterated over.
StringConcat
- Implements: IFragmentConcatenator
Converts all fragments to strings and concats those.
Drops 'undefined's.
Initializers
Name | Type | Description |
---|
Methods
Name | Description |
---|---|
join | Concatenates string fragments. |
join
Concatenates string fragments.
left
Required
- Type: any
right
Required
- Type: any
StringListList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
allWithMapKey | Creating an iterator for this complex list. |
computeFqn | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
allWithMapKey
Creating an iterator for this complex list.
The list will be converted into a map with the mapKeyAttributeName as the key.
mapKeyAttributeName
Required
- Type: string
computeFqn
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
StringListMap
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
key
Required
- Type: string
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
StringMap
- Implements: ITerraformAddressable, IResolvable
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
Methods
Name | Description |
---|---|
computeFqn | No description. |
lookup | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
computeFqn
lookup
key
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
StringMapList
Initializers
Name | Type | Description |
---|---|---|
terraformResource | IInterpolatingParent | No description. |
terraformAttribute | string | No description. |
wrapsSet | boolean | No description. |
terraformResource
Required
- Type: IInterpolatingParent
terraformAttribute
Required
- Type: string
wrapsSet
Required
- Type: boolean
Methods
Name | Description |
---|---|
computeFqn | No description. |
interpolationForAttribute | No description. |
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
get | No description. |
computeFqn
interpolationForAttribute
property
Required
- Type: string
resolve
Produce the Token's value at resolution time.
_context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
get
index
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
fqn | string | No description. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
fqn
Required
- Type: string
TaggedCloudWorkspaces
A set of Terraform Cloud workspace tags.
You will be able to use this working directory with any workspaces that have all of the specified tags, and can use the terraform workspace commands to switch between them or create new workspaces. New workspaces will automatically have the specified tags. This option conflicts with name.
Initializers
tags
Required
- Type: string[]
project
Optional
- Type: string
Methods
Name | Description |
---|---|
toTerraform | No description. |
toHclTerraform | No description. |
toTerraform
toHclTerraform
Properties
tags
Required
- Type: string[]
project
Optional
- Type: string
TerraformCount
Iterator for the Terraform count property.
Methods
Name | Description |
---|---|
toString | No description. |
toTerraform | No description. |
toString
toTerraform
Static Functions
Name | Description |
---|---|
isTerraformCount | No description. |
of | No description. |
isTerraformCount
x
Required
- Type: any
of
count
Required
- Type: number
Properties
Name | Type | Description |
---|---|---|
index | number | No description. |
index
Required
- Type: number
TerraformIterator
- Implements: ITerraformIterator
Initializers
Name | Type | Description |
---|
Methods
Name | Description |
---|---|
dynamic | Creates a dynamic expression that can be used to loop over this iterator in a dynamic block. |
forExpressionForList | Creates a for expression that results in a list. |
forExpressionForMap | Creates a for expression that results in a map. |
getAny | No description. |
getAnyMap | No description. |
getBoolean | No description. |
getBooleanMap | No description. |
getList | No description. |
getMap | No description. |
getNumber | No description. |
getNumberList | No description. |
getNumberMap | No description. |
getString | No description. |
getStringMap | No description. |
keys | Creates a for expression that maps the iterators to its keys. |
pluckProperty | Creates a for expression that accesses the key on each element of the iterator. |
values | Creates a for expression that maps the iterators to its value in case it is a map. |
dynamic
Creates a dynamic expression that can be used to loop over this iterator in a dynamic block.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
See https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-for-list-attributes
attributes
Required
- Type: {[ key: string ]: any}
forExpressionForList
Creates a for expression that results in a list.
This method allows you to create every possible for expression, but requires more knowledge about Terraform's for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty() instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromList(myIteratorSourceVar).forExpressionForList("val.foo if val.bar == true")
will result in [ for key, val in var.myIteratorSource: val.foo if val.bar == true ]
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
expression
Required
- Type: string | IResolvable
The expression to use in the for mapping.
forExpressionForMap
Creates a for expression that results in a map.
This method allows you to create every possible for expression, but requires more knowledge about Terraforms for expression syntax. For the most common use cases you can use keys(), values(), and pluckProperty instead.
You may write any valid Terraform for each expression, e.g.
TerraformIterator.fromMap(myIteratorSourceVar).forExpressionForMap("key", "val.foo if val.bar == true")
will result in { for key, val in var.myIteratorSource: key = > val.foo if val.bar == true }
.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
keyExpression
Required
- Type: string | IResolvable
The expression to use as key in the for mapping.
valueExpression
Required
- Type: string | IResolvable
The expression to use as value in the for mapping.
getAny
attribute
Required
- Type: string
name of the property to retrieve.
getAnyMap
attribute
Required
- Type: string
name of the property to retrieve.
getBoolean
attribute
Required
- Type: string
name of the property to retrieve.
getBooleanMap
attribute
Required
- Type: string
name of the property to retrieve.
getList
attribute
Required
- Type: string
name of the property to retrieve.
getMap
attribute
Required
- Type: string
name of the property to retrieve.
getNumber
attribute
Required
- Type: string
name of the property to retrieve.
getNumberList
attribute
Required
- Type: string
name of the property to retrieve.
getNumberMap
attribute
Required
- Type: string
name of the property to retrieve.
getString
attribute
Required
- Type: string
name of the property to retrieve.
getStringMap
attribute
Required
- Type: string
name of the property to retrieve.
keys
Creates a for expression that maps the iterators to its keys.
For lists these would be the indices, for maps the keys.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
pluckProperty
Creates a for expression that accesses the key on each element of the iterator.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
property
Required
- Type: string
The property of the iterators values to map to.
values
Creates a for expression that maps the iterators to its value in case it is a map.
For lists these would stay the same.
As this returns an IResolvable you might need to wrap the output in
a Token, e.g. Token.asString
.
Static Functions
Name | Description |
---|---|
fromComplexList | Creates a new iterator from a complex list. |
fromDataSources | Creates a new iterator from a data source that has been created with the for_each argument. |
fromList | Creates a new iterator from a list. |
fromMap | Creates a new iterator from a map. |
fromResources | Creates a new iterator from a resource that has been created with the for_each argument. |
fromComplexList
Creates a new iterator from a complex list.
One example for this would be a list of maps. The list will be converted into a map with the mapKeyAttributeName as the key.
Example
list
Required
- Type: IResolvable | ComplexList | StringMapList | NumberMapList | BooleanMapList | AnyMapList
the list to iterate over.
mapKeyAttributeName
Required
- Type: string
the name of the attribute that should be used as the key in the map.
Visit https://developer.hashicorp.com/terraform/cdktf/concepts/iterators#using-iterators-on-complex-lists for more information.
fromDataSources
Creates a new iterator from a data source that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
fromList
Creates a new iterator from a list.
list
Required
- Type: string[] | IResolvable | number[] | boolean | IResolvable[]
fromMap
Creates a new iterator from a map.
map
Required
- Type: ComplexMap | {[ key: string ]: any} | {[ key: string ]: string} | {[ key: string ]: number} | {[ key: string ]: boolean}
fromResources
Creates a new iterator from a resource that has been created with the for_each
argument.
resource
Required
- Type: ITerraformResource
TerraformResourceTargets
Initializers
Name | Type | Description |
---|
Methods
Name | Description |
---|---|
addResourceTarget | No description. |
getResourceByTarget | No description. |
addResourceTarget
resource
Required
- Type: TerraformResource
target
Required
- Type: string
getResourceByTarget
target
Required
- Type: string
TerraformSelf
Expressions in connection blocks cannot refer to their parent resource by name.
References create dependencies, and referring to a resource by name within its own block would create a dependency cycle. Instead, expressions can use the self object, which represents the connection's parent resource and has all of that resource's attributes. For example, use self.public_ip to reference an aws_instance's public_ip attribute.
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
getAny | Only usable within a connection block to reference the connections parent resource. |
getNumber | Only usable within a connection block to reference the connections parent resource. |
getString | Only usable within a connection block to reference the connections parent resource. |
getAny
Only usable within a connection block to reference the connections parent resource.
Access a property on the resource like this: getAny("hostPort")
key
Required
- Type: string
getNumber
Only usable within a connection block to reference the connections parent resource.
Access a property on the resource like this: getNumber("hostPort")
key
Required
- Type: string
getString
Only usable within a connection block to reference the connections parent resource.
Access a property on the resource like this: getString("publicIp")
key
Required
- Type: string
Testing
Testing utilities for cdktf applications.
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
app | Returns an app for testing with the following properties: - Output directory is a temp dir. |
enableFutureFlags | No description. |
fakeCdktfJsonPath | No description. |
fullSynth | No description. |
renderConstructTree | No description. |
setupJest | No description. |
stubVersion | No description. |
synth | Returns the Terraform synthesized JSON. |
synthHcl | Returns the Terraform synthesized JSON. |
synthScope | No description. |
toBeValidTerraform | No description. |
toHaveDataSource | No description. |
toHaveDataSourceWithProperties | No description. |
toHaveProvider | No description. |
toHaveProviderWithProperties | No description. |
toHaveResource | No description. |
toHaveResourceWithProperties | No description. |
app
Returns an app for testing with the following properties: - Output directory is a temp dir.
options
Optional
- Type: TestingAppConfig
enableFutureFlags
app
Required
- Type: App
fakeCdktfJsonPath
app
Required
- Type: App
fullSynth
stack
Required
- Type: TerraformStack
renderConstructTree
construct
Required
- Type: constructs.IConstruct
setupJest
stubVersion
app
Required
- Type: App
synth
Returns the Terraform synthesized JSON.
stack
Required
- Type: TerraformStack
runValidations
Optional
- Type: boolean
synthHcl
Returns the Terraform synthesized JSON.
stack
Required
- Type: TerraformStack
runValidations
Optional
- Type: boolean
returnMetadata
Optional
- Type: boolean
synthScope
fn
Required
- Type: IScopeCallback
toBeValidTerraform
received
Required
- Type: string
toHaveDataSource
received
Required
- Type: string
resourceType
Required
- Type: string
toHaveDataSourceWithProperties
received
Required
- Type: string
resourceType
Required
- Type: string
properties
Optional
- Type: {[ key: string ]: any}
toHaveProvider
received
Required
- Type: string
resourceType
Required
- Type: string
toHaveProviderWithProperties
received
Required
- Type: string
resourceType
Required
- Type: string
properties
Optional
- Type: {[ key: string ]: any}
toHaveResource
received
Required
- Type: string
resourceType
Required
- Type: string
toHaveResourceWithProperties
received
Required
- Type: string
resourceType
Required
- Type: string
properties
Optional
- Type: {[ key: string ]: any}
Token
Represents a special or lazily-evaluated value.
Can be used to delay evaluation of a certain value in case, for example, that it requires some context or late-bound data. Can also be used to mark values that need special processing at document rendering time.
Tokens can be embedded into strings while retaining their original semantics.
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
asAny | Return a resolvable representation of the given value. |
asAnyMap | Return a reversible map representation of this token. |
asBooleanMap | Return a reversible map representation of this token. |
asList | Return a reversible list representation of this token. |
asMap | Return a reversible map representation of this token. |
asNumber | Return a reversible number representation of this token. |
asNumberList | Return a reversible list representation of this token. |
asNumberMap | Return a reversible map representation of this token. |
asString | Return a reversible string representation of this token. |
asStringMap | Return a reversible map representation of this token. |
isUnresolved | Returns true if obj represents an unresolved value. |
nullValue | Return a Token containing a null value. |
asAny
Return a resolvable representation of the given value.
value
Required
- Type: any
asAnyMap
Return a reversible map representation of this token.
value
Required
- Type: any
options
Optional
- Type: EncodingOptions
asBooleanMap
Return a reversible map representation of this token.
value
Required
- Type: any
options
Optional
- Type: EncodingOptions
asList
Return a reversible list representation of this token.
value
Required
- Type: any
options
Optional
- Type: EncodingOptions
asMap
Return a reversible map representation of this token.
value
Required
- Type: any
mapValue
Required
- Type: any
options
Optional
- Type: EncodingOptions
asNumber
Return a reversible number representation of this token.
value
Required
- Type: any
asNumberList
Return a reversible list representation of this token.
value
Required
- Type: any
asNumberMap
Return a reversible map representation of this token.
value
Required
- Type: any
options
Optional
- Type: EncodingOptions
asString
Return a reversible string representation of this token.
If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.
Strings with quoted Tokens in them can be restored back into
complex values with the Tokens restored by calling resolve()
on the string.
value
Required
- Type: any
options
Optional
- Type: EncodingOptions
asStringMap
Return a reversible map representation of this token.
value
Required
- Type: any
options
Optional
- Type: EncodingOptions
isUnresolved
Returns true if obj represents an unresolved value.
One of these must be true:
obj
is an IResolvableobj
is a string containing at least one encodedIResolvable
obj
is either an encoded number or list
This does NOT recurse into lists or objects to see if they containing resolvables.
obj
Required
- Type: any
The object to test.
nullValue
Return a Token containing a null
value.
Note: This is different than undefined
, nil
, None
or similar
as it will end up in the Terraform config and can be used to explicitly
not set an attribute (which is sometimes required by Terraform providers)
Constants
Name | Type | Description |
---|---|---|
ANY_MAP_TOKEN_VALUE | string | Any map token representation. |
NUMBER_MAP_TOKEN_VALUE | number | Number Map token value representation. |
STRING_MAP_TOKEN_VALUE | string | String Map token value representation. |
ANY_MAP_TOKEN_VALUE
Required
- Type: string
Any map token representation.
NUMBER_MAP_TOKEN_VALUE
Required
- Type: number
Number Map token value representation.
STRING_MAP_TOKEN_VALUE
Required
- Type: string
String Map token value representation.
Tokenization
Less oft-needed functions to manipulate Tokens.
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
isResolvable | Return whether the given object is an IResolvable object. |
resolve | Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays. |
reverse | Reverse any value into Resolvables, if possible. |
reverseList | Un-encode a Tokenized value from a list. |
reverseMap | Un-encode a Tokenized value from a map. |
reverseNumber | Un-encode a Tokenized value from a number. |
reverseNumberList | Un-encode a Tokenized value from a list. |
reverseString | Un-encode a string potentially containing encoded tokens. |
stringifyNumber | Stringify a number directly or lazily if it's a Token. |
isResolvable
Return whether the given object is an IResolvable object.
This is different from Token.isUnresolved() which will also check for encoded Tokens, whereas this method will only do a type check on the given object.
obj
Required
- Type: any
resolve
Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays.
Values can only be primitives, arrays or tokens. Other objects (i.e. with methods) will be rejected.
obj
Required
- Type: any
The object to resolve.
options
Required
- Type: ResolveOptions
Prefix key path components for diagnostics.
reverse
Reverse any value into Resolvables, if possible.
x
Required
- Type: any
reverseList
Un-encode a Tokenized value from a list.
l
Required
- Type: string[]
reverseMap
Un-encode a Tokenized value from a map.
m
Required
- Type: {[ key: string ]: any}
reverseNumber
Un-encode a Tokenized value from a number.
n
Required
- Type: number
reverseNumberList
Un-encode a Tokenized value from a list.
l
Required
- Type: number[]
reverseString
Un-encode a string potentially containing encoded tokens.
s
Required
- Type: string
stringifyNumber
Stringify a number directly or lazily if it's a Token.
If it is an object (i.e., { Ref: 'SomeLogicalId' }), return it as-is.
x
Required
- Type: number
TokenizedStringFragments
Fragments of a concatenated string containing stringified Tokens.
Initializers
Name | Type | Description |
---|
Methods
Name | Description |
---|---|
addEscape | No description. |
addIntrinsic | Adds an intrinsic fragment. |
addLiteral | Adds a literal fragment. |
addToken | Adds a token fragment. |
concat | No description. |
join | Combine the string fragments using the given joiner. |
mapTokens | Apply a transformation function to all tokens in the string. |
addEscape
kind
Required
- Type: string
addIntrinsic
Adds an intrinsic fragment.
value
Required
- Type: any
the intrinsic value to add.
addLiteral
Adds a literal fragment.
lit
Required
- Type: any
the literal to add.
addToken
Adds a token fragment.
token
Required
- Type: IResolvable
the token to add.
concat
other
Required
- Type: TokenizedStringFragments
join
Combine the string fragments using the given joiner.
If there are any
concat
Required
- Type: IFragmentConcatenator
mapTokens
Apply a transformation function to all tokens in the string.
context
Required
- Type: IResolveContext
Properties
Name | Type | Description |
---|---|---|
escapes | IResolvable[] | Return all escape fragments from this string. |
firstValue | any | Returns the first value. |
intrinsic | IResolvable[] | Return all intrinsic fragments from this string. |
length | number | Returns the number of fragments. |
literals | IResolvable[] | Return all literals from this string. |
tokens | IResolvable[] | Return all Tokens from this string. |
firstToken | IResolvable | Returns the first token. |
escapes
Required
- Type: IResolvable[]
Return all escape fragments from this string.
firstValue
Required
- Type: any
Returns the first value.
intrinsic
Required
- Type: IResolvable[]
Return all intrinsic fragments from this string.
length
Required
- Type: number
Returns the number of fragments.
literals
Required
- Type: IResolvable[]
Return all literals from this string.
tokens
Required
- Type: IResolvable[]
Return all Tokens from this string.
firstToken
Optional
- Type: IResolvable
Returns the first token.
VariableType
Initializers
Name | Type | Description |
---|
Static Functions
Name | Description |
---|---|
list | No description. |
map | No description. |
object | No description. |
set | No description. |
tuple | No description. |
list
type
Required
- Type: string
map
type
Required
- Type: string
object
attributes
Required
- Type: {[ key: string ]: string}
set
type
Required
- Type: string
tuple
elements
Required
- Type: string
Constants
Name | Type | Description |
---|---|---|
ANY | string | No description. |
BOOL | string | No description. |
LIST | string | No description. |
LIST_BOOL | string | No description. |
LIST_NUMBER | string | No description. |
LIST_STRING | string | No description. |
MAP | string | No description. |
MAP_BOOL | string | No description. |
MAP_NUMBER | string | No description. |
MAP_STRING | string | No description. |
NUMBER | string | No description. |
SET | string | No description. |
SET_BOOL | string | No description. |
SET_NUMBER | string | No description. |
SET_STRING | string | No description. |
STRING | string | No description. |
ANY
Required
- Type: string
BOOL
Required
- Type: string
LIST
Required
- Type: string
LIST_BOOL
Required
- Type: string
LIST_NUMBER
Required
- Type: string
LIST_STRING
Required
- Type: string
MAP
Required
- Type: string
MAP_BOOL
Required
- Type: string
MAP_NUMBER
Required
- Type: string
MAP_STRING
Required
- Type: string
NUMBER
Required
- Type: string
SET
Required
- Type: string
SET_BOOL
Required
- Type: string
SET_NUMBER
Required
- Type: string
SET_STRING
Required
- Type: string
STRING
Required
- Type: string
Protocols
IAnyProducer
- Implemented By: IAnyProducer
Interface for lazy untyped value producers.
Methods
Name | Description |
---|---|
produce | Produce the value. |
produce
Produce the value.
context
Required
- Type: IResolveContext
IAspect
- Implemented By: MigrateIds, IAspect
Represents an Aspect.
Methods
Name | Description |
---|---|
visit | All aspects can visit an IConstruct. |
visit
All aspects can visit an IConstruct.
node
Required
- Type: constructs.IConstruct
IFragmentConcatenator
- Implemented By: StringConcat, IFragmentConcatenator
Function used to concatenate symbols in the target document language.
Interface so it could potentially be exposed over jsii.
Methods
Name | Description |
---|---|
join | Join the fragment on the left and on the right. |
join
Join the fragment on the left and on the right.
left
Required
- Type: any
right
Required
- Type: any
IImportableConfig
- Implemented By: IImportableConfig
Properties
Name | Type | Description |
---|---|---|
importId | string | No description. |
terraformResourceType | string | No description. |
provider | TerraformProvider | No description. |
importId
Required
- Type: string
terraformResourceType
Required
- Type: string
provider
Optional
- Type: TerraformProvider
IInterpolatingParent
- Implemented By: AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, DataResource, MapList, NumberMapList, StringMapList, TerraformDataSource, TerraformResource, IInterpolatingParent
Methods
Name | Description |
---|---|
interpolationForAttribute | No description. |
interpolationForAttribute
terraformAttribute
Required
- Type: string
IListProducer
- Implemented By: IListProducer
Interface for lazy list producers.
Methods
Name | Description |
---|---|
produce | Produce the list value. |
produce
Produce the list value.
context
Required
- Type: IResolveContext
IManifest
Properties
Name | Type | Description |
---|---|---|
stacks | {[ key: string ]: StackManifest} | No description. |
version | string | No description. |
stacks
Required
- Type: {[ key: string ]: StackManifest}
version
Required
- Type: string
INumberProducer
- Implemented By: INumberProducer
Interface for lazy number producers.
Methods
Name | Description |
---|---|
produce | Produce the number value. |
produce
Produce the number value.
context
Required
- Type: IResolveContext
IPostProcessor
- Implemented By: IPostProcessor
A Token that can post-process the complete resolved value, after resolve() has recursed over it.
Methods
Name | Description |
---|---|
postProcess | Process the completely resolved value, after full recursion/resolution has happened. |
postProcess
Process the completely resolved value, after full recursion/resolution has happened.
input
Required
- Type: any
context
Required
- Type: IResolveContext
IRemoteWorkspace
- Implemented By: NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace
IResolvable
- Implemented By: AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, IResolvable
Interface for values that can be resolvable later.
Tokens are special objects that participate in synthesis.
Methods
Name | Description |
---|---|
resolve | Produce the Token's value at resolution time. |
toString | Return a string representation of this resolvable object. |
resolve
Produce the Token's value at resolution time.
context
Required
- Type: IResolveContext
toString
Return a string representation of this resolvable object.
Returns a reversible string representation.
Properties
Name | Type | Description |
---|---|---|
creationStack | string[] | The creation stack of this resolvable which will be appended to errors thrown during resolution. |
creationStack
Required
- Type: string[]
The creation stack of this resolvable which will be appended to errors thrown during resolution.
If this returns an empty array the stack will not be attached.
IResolveContext
- Implemented By: IResolveContext
Current resolution context for tokens.
Methods
Name | Description |
---|---|
registerPostProcessor | Use this postprocessor after the entire token structure has been resolved. |
resolve | Resolve an inner object. |
registerPostProcessor
Use this postprocessor after the entire token structure has been resolved.
postProcessor
Required
- Type: IPostProcessor
resolve
Resolve an inner object.
x
Required
- Type: any
Properties
Name | Type | Description |
---|---|---|
preparing | boolean | True when we are still preparing, false if we're rendering the final output. |
scope | constructs.IConstruct | The scope from which resolution has been initiated. |
ignoreEscapes | boolean | True when ${} should not be parsed, and treated as literals. |
iteratorContext | string | TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key. |
suppressBraces | boolean | True when ${} should be ommitted (because already inside them), false otherwise. |
warnEscapes | boolean | True when ${} should not be included in the string to be resolved, outputs a warning. |
preparing
Required
- Type: boolean
True when we are still preparing, false if we're rendering the final output.
scope
Required
- Type: constructs.IConstruct
The scope from which resolution has been initiated.
ignoreEscapes
Optional
- Type: boolean
True when ${} should not be parsed, and treated as literals.
iteratorContext
Optional
- Type: string
TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
suppressBraces
Optional
- Type: boolean
True when ${} should be ommitted (because already inside them), false otherwise.
warnEscapes
Optional
- Type: boolean
True when ${} should not be included in the string to be resolved, outputs a warning.
Default: false
IResource
Properties
Name | Type | Description |
---|---|---|
node | constructs.Node | The tree node. |
stack | TerraformStack | The stack in which this resource is defined. |
node
Required
- Type: constructs.Node
The tree node.
stack
Required
- Type: TerraformStack
The stack in which this resource is defined.
IResourceConstructor
- Implemented By: IResourceConstructor
IScopeCallback
- Implemented By: IScopeCallback
IStackSynthesizer
- Implemented By: IStackSynthesizer
Encodes information how a certain Stack should be deployed inspired by AWS CDK v2 implementation (synth functionality was removed in constructs v10).
Methods
Name | Description |
---|---|
synthesize | Synthesize the associated stack to the session. |
synthesize
Synthesize the associated stack to the session.
session
Required
- Type: ISynthesisSession
IStringProducer
- Implemented By: IStringProducer
Interface for lazy string producers.
Methods
Name | Description |
---|---|
produce | Produce the string value. |
produce
Produce the string value.
context
Required
- Type: IResolveContext
ISynthesisSession
- Implemented By: ISynthesisSession
Represents a single session of synthesis.
Passed into TerraformStack.onSynthesize()
methods.
originally from aws/constructs lib v3.3.126 (synth functionality was removed in constructs v10)
Properties
Name | Type | Description |
---|---|---|
manifest | Manifest | No description. |
outdir | string | The output directory for this synthesis session. |
skipValidation | boolean | No description. |
manifest
Required
- Type: Manifest
outdir
Required
- Type: string
The output directory for this synthesis session.
skipValidation
Optional
- Type: boolean
ITerraformAddressable
- Implemented By: AnyListList, AnyListMap, AnyMap, AnyMapList, BooleanList, BooleanListList, BooleanListMap, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataResource, DataTerraformRemoteState, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, MapList, NumberListList, NumberListMap, NumberMap, NumberMapList, StringListList, StringListMap, StringMap, StringMapList, TerraformDataSource, TerraformHclModule, TerraformLocal, TerraformModule, TerraformRemoteState, TerraformResource, TerraformVariable, ITerraformAddressable, ITerraformDependable
Properties
Name | Type | Description |
---|---|---|
fqn | string | No description. |
fqn
Required
- Type: string
ITerraformDependable
Extends: ITerraformAddressable
Implemented By: DataResource, TerraformDataSource, TerraformHclModule, TerraformModule, TerraformResource, ITerraformDependable
Properties
Name | Type | Description |
---|---|---|
fqn | string | No description. |
fqn
Required
- Type: string
ITerraformIterator
- Implemented By: DynamicListTerraformIterator, ListTerraformIterator, MapTerraformIterator, ResourceTerraformIterator, TerraformIterator, ITerraformIterator
ITerraformResource
- Implemented By: DataResource, TerraformDataSource, TerraformResource, ITerraformResource
Methods
Name | Description |
---|---|
interpolationForAttribute | No description. |
interpolationForAttribute
terraformAttribute
Required
- Type: string
Properties
Name | Type | Description |
---|---|---|
fqn | string | No description. |
friendlyUniqueId | string | No description. |
terraformResourceType | string | No description. |
count | number | TerraformCount | No description. |
dependsOn | string[] | No description. |
forEach | ITerraformIterator | No description. |
lifecycle | TerraformResourceLifecycle | No description. |
provider | TerraformProvider | No description. |
fqn
Required
- Type: string
friendlyUniqueId
Required
- Type: string
terraformResourceType
Required
- Type: string
count
Optional
- Type: number | TerraformCount
dependsOn
Optional
- Type: string[]
forEach
Optional
- Type: ITerraformIterator
lifecycle
Optional
provider
Optional
- Type: TerraformProvider
ITokenMapper
- Implemented By: ITokenMapper
Interface to apply operation to tokens in a string.
Interface so it can be exported via jsii.
Methods
Name | Description |
---|---|
mapToken | Replace a single token. |
mapToken
Replace a single token.
t
Required
- Type: IResolvable
ITokenResolver
- Implemented By: DefaultTokenResolver, ITokenResolver
How to resolve tokens.
Methods
Name | Description |
---|---|
resolveList | Resolve a tokenized list. |
resolveMap | Resolve a tokenized map. |
resolveNumberList | Resolve a tokenized number list. |
resolveString | Resolve a string with at least one stringified token in it. |
resolveToken | Resolve a single token. |
resolveList
Resolve a tokenized list.
l
Required
- Type: string[]
context
Required
- Type: IResolveContext
resolveMap
Resolve a tokenized map.
m
Required
- Type: {[ key: string ]: any}
context
Required
- Type: IResolveContext
resolveNumberList
Resolve a tokenized number list.
l
Required
- Type: number[]
context
Required
- Type: IResolveContext
resolveString
Resolve a string with at least one stringified token in it.
(May use concatenation)
s
Required
- Type: TokenizedStringFragments
context
Required
- Type: IResolveContext
resolveToken
Resolve a single token.
t
Required
- Type: IResolvable
context
Required
- Type: IResolveContext
postProcessor
Required
- Type: IPostProcessor