A new platform for documentation and tutorials is launching soon.
We are migrating Terraform documentation into HashiCorp Developer, our new developer experience.
»API Reference for CSharp
»Constructs
»App
Represents a cdktf application.
»Initializers
Name | Type | Description |
---|---|---|
Options | AppOptions | configuration options. |
»Options
Optional
- Type: AppOptions
configuration options.
»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: object
Any object.
»IsApp
»X
Required
- Type: object
»Of
»Construct
Required
- Type: Constructs.IConstruct
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
Manifest | Manifest | No description. |
Outdir | string | The output directory into which resources will be synthesized. |
SkipValidation | bool | Whether to skip the validation during synthesis of the app. |
TargetStackId | string | The stack which will be synthesized. |
»Node
Required
- Type: Constructs.Node
The tree node.
»Manifest
Required
- Type: Manifest
»Outdir
Required
- Type: string
The output directory into which resources will be synthesized.
»SkipValidation
Optional
- Type: bool
Whether to skip the validation during synthesis of the app.
»TargetStackId
Optional
- Type: string
The stack which will be synthesized.
If not set, all stacks will be synthesized.
»ArtifactoryBackend
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | ArtifactoryBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: ArtifactoryBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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
»AzurermBackend
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | AzurermBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: AzurermBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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://www.terraform.io/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 | CloudBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: CloudBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | ConsulBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: ConsulBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | CosBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: CosBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
»Node
Required
- Type: Constructs.Node
The tree node.
»CdktfStack
Required
- Type: TerraformStack
»Fqn
Required
- Type: string
»FriendlyUniqueId
Required
- Type: string
»DataTerraformRemoteState
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateRemoteConfig | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Config
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
»Node
Required
- Type: Constructs.Node
The tree node.
»CdktfStack
Required
- Type: TerraformStack
»Fqn
Required
- Type: string
»FriendlyUniqueId
Required
- Type: string
»Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
»TfResourceType
Required
- Type: string
»DataTerraformRemoteStateArtifactory
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateArtifactoryConfig | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Config
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
»Node
Required
- Type: Constructs.Node
The tree node.
»CdktfStack
Required
- Type: TerraformStack
»Fqn
Required
- Type: string
»FriendlyUniqueId
Required
- Type: string
»Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
»TfResourceType
Required
- Type: string
»DataTerraformRemoteStateConsul
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateConsulConfig | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Config
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
»Node
Required
- Type: Constructs.Node
The tree node.
»CdktfStack
Required
- Type: TerraformStack
»Fqn
Required
- Type: string
»FriendlyUniqueId
Required
- Type: string
»Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
»TfResourceType
Required
- Type: string
»DataTerraformRemoteStateCos
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateCosConfig | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Config
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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
»DataTerraformRemoteStateEtcd
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateEtcdConfig | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Config
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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
»DataTerraformRemoteStateEtcdV3
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateEtcdV3Config | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Config
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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
»DataTerraformRemoteStateManta
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateMantaConfig | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Config
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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
»EtcdBackend
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | EtcdBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: EtcdBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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
»EtcdV3Backend
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | EtcdV3BackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: EtcdV3BackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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
»GcsBackend
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | GcsBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: GcsBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | HttpBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: HttpBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | LocalBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Optional
- Type: LocalBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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
»MantaBackend
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | MantaBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: MantaBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | OssBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: OssBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | PgBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: PgBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | RemoteBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: RemoteBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
»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: object
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 | S3BackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: S3BackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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 | SwiftBackendProps | No description. |
»Scope
Required
- Type: Constructs.Construct
»Props
Required
- Type: SwiftBackendProps
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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
»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: object
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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»GetRemoteStateDataSource
Creates a TerraformRemoteState resource that accesses this backend.
»Scope
Required
- Type: Constructs.Construct
»Name
Required
- Type: string
»FromStack
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
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: object
Any object.
»IsBackend
»X
Required
- Type: object
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»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. |
»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: object
Any object.
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
TerraformMetaArguments | System.Collections.Generic.IDictionary< string, object > | No description. |
TerraformResourceType | string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Count | double | 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: System.Collections.Generic.IDictionary< string, object >
»TerraformResourceType
Required
- Type: string
»TerraformGeneratorMetadata
Optional
»Count
Optional
- Type: double
»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. |
ToMetadata | No description. |
ToTerraform | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
»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: object
Any object.
»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 | TerraformHclModuleOptions | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Options
Required
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | 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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
»AddProvider
»Provider
Required
- Type: object
»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: object
»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: object
Any object.
»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 | object[] | No description. |
SkipAssetCreationFromLocalModules | bool | No description. |
Version | string | No description. |
DependsOn | string[] | No description. |
ForEach | ITerraformIterator | No description. |
Variables | System.Collections.Generic.IDictionary< string, object > | 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: object[]
»SkipAssetCreationFromLocalModules
Optional
- Type: bool
»Version
Optional
- Type: string
»DependsOn
Optional
- Type: string[]
»ForEach
Optional
- Type: ITerraformIterator
»Variables
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»TerraformLocal
- Implements: ITerraformAddressable
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Expression | object | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Expression
Required
- Type: object
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
»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: object
Any object.
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
AsBoolean | IResolvable | No description. |
AsList | string[] | No description. |
AsNumber | double | No description. |
AsString | string | No description. |
Expression | object | No description. |
»Node
Required
- Type: Constructs.Node
The tree node.
»CdktfStack
Required
- Type: TerraformStack
»Fqn
Required
- Type: string
»FriendlyUniqueId
Required
- Type: string
»AsBoolean
Required
- Type: IResolvable
»AsList
Required
- Type: string[]
»AsNumber
Required
- Type: double
»AsString
Required
- Type: string
»Expression
Required
- Type: object
»TerraformModule
- Implements: ITerraformDependable
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Options | TerraformModuleOptions | No description. |
»Scope
Required
- Type: Constructs.Construct
»Id
Required
- Type: string
»Options
Required
- Type: TerraformModuleOptions
»Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToMetadata | No description. |
ToTerraform | 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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
»AddProvider
»Provider
Required
- Type: object
»GetString
»Output
Required
- Type: string
»InterpolationForOutput
»ModuleOutput
Required
- Type: string
»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: object
Any object.
»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 | object[] | No description. |
SkipAssetCreationFromLocalModules | bool | 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: object[]
»SkipAssetCreationFromLocalModules
Optional
- Type: bool
»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. |
ToMetadata | No description. |
ToTerraform | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerrafromOutput | 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: object
Any object.
»IsTerrafromOutput
»X
Required
- Type: object
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
StaticId | bool | No description. |
Value | object | No description. |
DependsOn | ITerraformDependable[] | No description. |
Description | string | No description. |
Sensitive | bool | 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: bool
»Value
Required
- Type: object
»DependsOn
Optional
- Type: ITerraformDependable[]
»Description
Optional
- Type: string
»Sensitive
Optional
- Type: bool
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»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: object
Any object.
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
MetaAttributes | System.Collections.Generic.IDictionary< string, object > | 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: System.Collections.Generic.IDictionary< string, object >
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»Get
»Output
Required
- Type: string
»GetBoolean
»Output
Required
- Type: string
»GetList
»Output
Required
- Type: string
»GetNumber
»Output
Required
- Type: string
»GetString
»Output
Required
- Type: string
»Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
»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: object
Any object.
»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. |
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: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
Adds this resource to the terraform JSON output.
»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. |
»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: object
Any object.
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
TerraformMetaArguments | System.Collections.Generic.IDictionary< string, object > | No description. |
TerraformResourceType | string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Connection | object | No description. |
Count | double | No description. |
DependsOn | string[] | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Provisioners | object[] | 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: System.Collections.Generic.IDictionary< string, object >
»TerraformResourceType
Required
- Type: string
»TerraformGeneratorMetadata
Optional
»Connection
Optional
- Type: object
»Count
Optional
- Type: double
»DependsOn
Optional
- Type: string[]
»ForEach
Optional
- Type: ITerraformIterator
»Lifecycle
Optional
»Provider
Optional
- Type: TerraformProvider
»Provisioners
Optional
- Type: object[]
»TerraformStack
»Initializers
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
»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. |
PrepareStack | No description. |
RegisterIncomingCrossStackReference | No description. |
RegisterOutgoingCrossStackReference | No description. |
RunAllValidations | Run all validations on the stack. |
ToTerraform | No description. |
»ToString
Returns a string representation of this construct.
»AddDependency
»Dependency
Required
- Type: TerraformStack
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»AllProviders
»DependsOn
»Stack
Required
- Type: TerraformStack
»EnsureBackendExists
»GetLogicalId
»TfElement
Required
- Type: object
»PrepareStack
»RegisterIncomingCrossStackReference
»FromStack
Required
- Type: TerraformStack
»RegisterOutgoingCrossStackReference
»Identifier
Required
- Type: string
»RunAllValidations
Run all validations on the stack.
»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: object
Any object.
»IsStack
»X
Required
- Type: object
»Of
»Construct
Required
- Type: Constructs.IConstruct
»Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
Dependencies | TerraformStack[] | No description. |
Synthesizer | IStackSynthesizer | No description. |
»Node
Required
- Type: Constructs.Node
The tree node.
»Dependencies
Required
- Type: TerraformStack[]
»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. |
ToMetadata | No description. |
ToTerraform | No description. |
AddValidation | No description. |
SynthesizeAttributes | No description. |
»ToString
Returns a string representation of this construct.
»AddOverride
»Path
Required
- Type: string
»Value
Required
- Type: object
»OverrideLogicalId
Overrides the auto-generated logical ID with a specific ID.
»NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
»ResetOverrideLogicalId
Resets a previously passed logical Id to use the auto-generated logical id again.
»ToMetadata
»ToTerraform
»AddValidation
»Validation
Required
»SynthesizeAttributes
»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: object
Any object.
»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 | double | No description. |
StringValue | string | No description. |
Value | object | No description. |
Default | object | No description. |
Description | string | No description. |
Nullable | bool | No description. |
Sensitive | bool | 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: double
»StringValue
Required
- Type: string
»Value
Required
- Type: object
»Default
Optional
- Type: object
»Description
Optional
- Type: string
»Nullable
Optional
- Type: bool
»Sensitive
Optional
- Type: bool
»Type
Optional
- Type: string
»Validation
Optional
»Structs
»AppOptions
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Context | System.Collections.Generic.IDictionary< string, object > | Additional context values for the application. |
Outdir | string | The directory to output Terraform resources. |
SkipValidation | bool | Whether to skip the validation during synthesis of the app. |
StackTraces | bool | No description. |
»Context
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
- 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)
.
»Outdir
Optional
- Type: string
- Default: CDKTF_OUTDIR if defined, otherwise "cdktf.out"
The directory to output Terraform resources.
»SkipValidation
Optional
- Type: bool
- Default: false
Whether to skip the validation during synthesis of the app.
»StackTraces
Optional
- Type: bool
»ArtifactoryBackendProps
Stores the state as an artifact in a given repository in Artifactory.
Generic HTTP repositories are supported, and state from different configurations may be kept at different subpaths within the repository.
Note: The URL must include the path to the Artifactory installation. It will likely end in /artifactory.
This backend does not support state locking.
Read more about this backend in the Terraform docs: https://www.terraform.io/language/settings/backends/artifactory
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Password | string | (Required) - The password. |
Repo | string | (Required) - The repository name. |
Subpath | string | (Required) - Path within the repository. |
Url | string | (Required) - The URL. |
Username | string | (Required) - The username. |
»Password
Required
- Type: string
(Required) - The password.
»Repo
Required
- Type: string
(Required) - The repository name.
»Subpath
Required
- Type: string
(Required) - Path within the repository.
»Url
Required
- Type: string
(Required) - The URL.
Note that this is the base url to artifactory not the full repo and subpath.
»Username
Required
- Type: string
(Required) - The username.
»AzurermBackendProps
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://www.terraform.io/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. |
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. |
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 | bool | (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 | bool | (Optional) Should AzureAD Authentication be used to access the Blob Storage Account. |
UseMicrosoftGraph | bool | (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? |
UseMsi | bool | (Optional) Should Managed Service Identity authentication be used? |
UseOidc | bool | (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.
»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.
»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: bool
(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: bool
(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: bool
(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: bool
(Optional) Should Managed Service Identity authentication be used?
This can also be sourced from the ARM_USE_MSI environment variable.
»UseOidc
Optional
- Type: bool
(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).
»CloudBackendProps
The Cloud Backend synthesizes a {@link https://www.terraform.io/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://www.terraform.io/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 | object | 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
- Type: object
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.
»ConsulBackendProps
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://www.terraform.io/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 | bool | (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 | bool | (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: bool
(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: bool
(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.
»CosBackendProps
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://www.terraform.io/language/settings/backends/cos
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Bucket | string | (Required) The name of the COS bucket. |
Acl | string | (Optional) Object ACL to be applied to the state file, allows private and public-read. |
Encrypt | bool | (Optional) Whether to enable server side encryption of the state file. |
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. |
»Bucket
Required
- Type: string
(Required) The name of the COS bucket.
You shall manually create it first.
»Acl
Optional
- Type: string
(Optional) Object ACL to be applied to the state file, allows private and public-read.
Defaults to private.
»Encrypt
Optional
- Type: bool
(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.
»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.
»DataTerraformRemoteStateArtifactoryConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
Password | string | (Required) - The password. |
Repo | string | (Required) - The repository name. |
Subpath | string | (Required) - Path within the repository. |
Url | string | (Required) - The URL. |
Username | string | (Required) - The username. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Password
Required
- Type: string
(Required) - The password.
»Repo
Required
- Type: string
(Required) - The repository name.
»Subpath
Required
- Type: string
(Required) - Path within the repository.
»Url
Required
- Type: string
(Required) - The URL.
Note that this is the base url to artifactory not the full repo and subpath.
»Username
Required
- Type: string
(Required) - The username.
»DataTerraformRemoteStateAzurermConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | 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. |
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. |
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 | bool | (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 | bool | (Optional) Should AzureAD Authentication be used to access the Blob Storage Account. |
UseMicrosoftGraph | bool | (Optional) Should MSAL be used for authentication instead of ADAL, and should Microsoft Graph be used instead of Azure Active Directory Graph? |
UseMsi | bool | (Optional) Should Managed Service Identity authentication be used? |
UseOidc | bool | (Optional) Should OIDC authentication be used? This can also be sourced from the ARM_USE_OIDC environment variable. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»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.
»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.
»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: bool
(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: bool
(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: bool
(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: bool
(Optional) Should Managed Service Identity authentication be used?
This can also be sourced from the ARM_USE_MSI environment variable.
»UseOidc
Optional
- Type: bool
(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
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»DataTerraformRemoteStateConsulConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | 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 | bool | (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 | bool | (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: System.Collections.Generic.IDictionary< string, object >
»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: bool
(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: bool
(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 | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
Bucket | string | (Required) The name of the COS bucket. |
Acl | string | (Optional) Object ACL to be applied to the state file, allows private and public-read. |
Encrypt | bool | (Optional) Whether to enable server side encryption of the state file. |
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. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Bucket
Required
- Type: string
(Required) The name of the COS bucket.
You shall manually create it first.
»Acl
Optional
- Type: string
(Optional) Object ACL to be applied to the state file, allows private and public-read.
Defaults to private.
»Encrypt
Optional
- Type: bool
(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.
»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.
»DataTerraformRemoteStateEtcdConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
Endpoints | string | (Required) A space-separated list of the etcd endpoints. |
Path | string | (Required) The path where to store the state. |
Password | string | (Optional) The password. |
Username | string | (Optional) The username. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Endpoints
Required
- Type: string
(Required) A space-separated list of the etcd endpoints.
»Path
Required
- Type: string
(Required) The path where to store the state.
»Password
Optional
- Type: string
(Optional) The password.
»Username
Optional
- Type: string
(Optional) The username.
»DataTerraformRemoteStateEtcdV3Config
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
Endpoints | string[] | (Required) The list of 'etcd' endpoints which to connect to. |
CacertPath | string | (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers. |
CertPath | string | (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification. |
KeyPath | string | (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification. |
Lock | bool | (Optional) Whether to lock state access. |
Password | string | (Optional) Password used to connect to the etcd cluster. |
Prefix | string | (Optional) An optional prefix to be added to keys when to storing state in etcd. |
Username | string | (Optional) Username used to connect to the etcd cluster. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Endpoints
Required
- Type: string[]
(Required) The list of 'etcd' endpoints which to connect to.
»CacertPath
Optional
- Type: string
(Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers.
»CertPath
Optional
- Type: string
(Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification.
»KeyPath
Optional
- Type: string
(Optional) The path to a PEM-encoded key to provide to etcd for secure client identification.
»Lock
Optional
- Type: bool
(Optional) Whether to lock state access.
Defaults to true.
»Password
Optional
- Type: string
(Optional) Password used to connect to the etcd cluster.
»Prefix
Optional
- Type: string
(Optional) An optional prefix to be added to keys when to storing state in etcd.
Defaults to "".
»Username
Optional
- Type: string
(Optional) Username used to connect to the etcd cluster.
»DataTerraformRemoteStateGcsConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | 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. |
Prefix | string | (Optional) GCS prefix inside the bucket. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»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.
»Prefix
Optional
- Type: string
(Optional) GCS prefix inside the bucket.
Named states for workspaces are stored in an object called < prefix >/< name >.tfstate.
»DataTerraformRemoteStateHttpConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
Address | string | (Required) The address of the REST endpoint. |
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 | double | (Optional) The number of HTTP request retries. |
RetryWaitMax | double | (Optional) The maximum time in seconds to wait between HTTP request attempts. |
RetryWaitMin | double | (Optional) The minimum time in seconds to wait between HTTP request attempts. |
SkipCertVerification | bool | (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: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Address
Required
- Type: string
(Required) The address of the REST endpoint.
»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: double
(Optional) The number of HTTP request retries.
Defaults to 2.
»RetryWaitMax
Optional
- Type: double
(Optional) The maximum time in seconds to wait between HTTP request attempts.
Defaults to 30.
»RetryWaitMin
Optional
- Type: double
(Optional) The minimum time in seconds to wait between HTTP request attempts.
Defaults to 1.
»SkipCertVerification
Optional
- Type: bool
(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 | System.Collections.Generic.IDictionary< string, object > | 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: System.Collections.Generic.IDictionary< string, object >
»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.
»DataTerraformRemoteStateMantaConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
Account | string | No description. |
KeyId | string | No description. |
Path | string | No description. |
InsecureSkipTlsVerify | bool | No description. |
KeyMaterial | string | No description. |
ObjectName | string | No description. |
Url | string | No description. |
User | string | No description. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Account
Required
- Type: string
»KeyId
Required
- Type: string
»Path
Required
- Type: string
»InsecureSkipTlsVerify
Optional
- Type: bool
»KeyMaterial
Optional
- Type: string
»ObjectName
Optional
- Type: string
»Url
Optional
- Type: string
»User
Optional
- Type: string
»DataTerraformRemoteStateOssConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
Bucket | string | No description. |
AccessKey | string | No description. |
Acl | string | No description. |
AssumeRole | OssAssumeRole | No description. |
EcsRoleName | string | No description. |
Encrypt | bool | No description. |
Endpoint | string | No description. |
Key | string | No description. |
Prefix | string | No description. |
Profile | string | No description. |
Region | string | No description. |
SecretKey | string | No description. |
SecurityToken | string | No description. |
SharedCredentialsFile | string | No description. |
TablestoreEndpoint | string | No description. |
TablestoreTable | string | No description. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Bucket
Required
- Type: string
»AccessKey
Optional
- Type: string
»Acl
Optional
- Type: string
»AssumeRole
Optional
- Type: OssAssumeRole
»EcsRoleName
Optional
- Type: string
»Encrypt
Optional
- Type: bool
»Endpoint
Optional
- Type: string
»Key
Optional
- Type: string
»Prefix
Optional
- Type: string
»Profile
Optional
- Type: string
»Region
Optional
- Type: string
»SecretKey
Optional
- Type: string
»SecurityToken
Optional
- Type: string
»SharedCredentialsFile
Optional
- Type: string
»TablestoreEndpoint
Optional
- Type: string
»TablestoreTable
Optional
- Type: string
»DataTerraformRemoteStatePgConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | No description. |
Workspace | string | No description. |
ConnStr | string | No description. |
SchemaName | string | No description. |
SkipSchemaCreation | bool | No description. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»ConnStr
Required
- Type: string
»SchemaName
Optional
- Type: string
»SkipSchemaCreation
Optional
- Type: bool
»DataTerraformRemoteStateRemoteConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Defaults | System.Collections.Generic.IDictionary< string, object > | 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: System.Collections.Generic.IDictionary< string, object >
»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 | System.Collections.Generic.IDictionary< string, object > | 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. |
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 | System.Collections.Generic.IDictionary< 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. |
DynamodbEndpoint | string | (Optional) Custom endpoint for the AWS DynamoDB API. |
DynamodbTable | string | (Optional) Name of DynamoDB Table to use for state locking and consistency. |
Encrypt | bool | (Optional) Enable server side encryption of the state file. |
Endpoint | string | (Optional) Custom endpoint for the AWS S3 API. |
ExternalId | string | (Optional) External identifier to use when assuming the role. |
ForcePathStyle | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
IamEndpoint | string | (Optional) Custom endpoint for the AWS Identity and Access Management (IAM) API. |
KmsKeyId | string | (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. |
MaxRetries | double | (Optional) The maximum number of times an AWS API request is retried on retryable failure. |
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). |
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. |
SharedCredentialsFile | string | (Optional) Path to the AWS shared credentials file. |
SkipCredentialsValidation | bool | (Optional) Skip credentials validation via the STS API. |
SkipMetadataApiCheck | bool | (Optional) Skip usage of EC2 Metadata API. |
SkipRegionValidation | bool | (Optional) Skip validation of provided region name. |
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. |
Token | string | (Optional) Multi-Factor Authentication (MFA) token. |
WorkspaceKeyPrefix | string | (Optional) Prefix applied to the state path inside the bucket. |
»Defaults
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»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.
»AssumeRolePolicy
Optional
- Type: string
(Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
»AssumeRolePolicyArns
Optional
- Type: string[]
(Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
»AssumeRoleTags
Optional
- Type: System.Collections.Generic.IDictionary< string, string >
(Optional) Map of assume role session tags.
»AssumeRoleTransitiveTagKeys
Optional
- Type: string[]
(Optional) Set of assume role session tag keys to pass to any subsequent sessions.
»DynamodbEndpoint
Optional
- 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.
»Encrypt
Optional
- Type: bool
(Optional) Enable server side encryption of the state file.
»Endpoint
Optional
- Type: string
(Optional) Custom endpoint for the AWS S3 API.
This can also be sourced from the AWS_S3_ENDPOINT environment variable.
»ExternalId
Optional
- Type: string
(Optional) External identifier to use when assuming the role.
»ForcePathStyle
Optional
- Type: bool
(Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >).
»IamEndpoint
Optional
- 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.
»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: double
(Optional) The maximum number of times an AWS API request is retried on retryable failure.
Defaults to 5.
»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.
»RoleArn
Optional
- 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
- Type: string
(Optional) Session name to use when assuming the role.
»SharedCredentialsFile
Optional
- Type: string
(Optional) Path to the AWS shared credentials file.
Defaults to ~/.aws/credentials.
»SkipCredentialsValidation
Optional
- Type: bool
(Optional) Skip credentials validation via the STS API.
»SkipMetadataApiCheck
Optional
- Type: bool
(Optional) Skip usage of EC2 Metadata API.
»SkipRegionValidation
Optional
- Type: bool
(Optional) Skip validation of provided region name.
»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
- 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.
»Token
Optional
- Type: string
(Optional) Multi-Factor Authentication (MFA) token.
This can also be sourced from the AWS_SESSION_TOKEN environment variable.
»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 | System.Collections.Generic.IDictionary< string, object > | 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 | bool | 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
- Type: System.Collections.Generic.IDictionary< string, object >
»Workspace
Optional
- Type: string
»Container
Required
- Type: string
»ApplicationCredentialId
Optional
- Type: string
»ApplicationCredentialName
Optional
- Type: string
»ApplicationCredentialSecret
Optional
- Type: string
»ArchiveContainer
Optional
- Type: string
»AuthUrl
Optional
- Type: string
»CacertFile
Optional
- Type: string
»Cert
Optional
- Type: string
»Cloud
Optional
- Type: string
»DefaultDomain
Optional
- Type: string
»DomainId
Optional
- Type: string
»DomainName
Optional
- Type: string
»ExpireAfter
Optional
- Type: string
»Insecure
Optional
- Type: bool
»Key
Optional
- Type: string
»Password
Optional
- Type: string
»ProjectDomainId
Optional
- Type: string
»ProjectDomainName
Optional
- Type: string
»RegionName
Optional
- Type: string
»StateName
Optional
- Type: string
»TenantId
Optional
- Type: string
»TenantName
Optional
- Type: string
»Token
Optional
- Type: string
»UserDomainId
Optional
- Type: string
»UserDomainName
Optional
- Type: string
»UserId
Optional
- Type: string
»UserName
Optional
- 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.
»EtcdBackendProps
Stores the state in etcd 2.x at a given path.
This backend does not support state locking.
Read more about this backend in the Terraform docs: https://www.terraform.io/language/settings/backends/etcd
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Endpoints | string | (Required) A space-separated list of the etcd endpoints. |
Path | string | (Required) The path where to store the state. |
Password | string | (Optional) The password. |
Username | string | (Optional) The username. |
»Endpoints
Required
- Type: string
(Required) A space-separated list of the etcd endpoints.
»Path
Required
- Type: string
(Required) The path where to store the state.
»Password
Optional
- Type: string
(Optional) The password.
»Username
Optional
- Type: string
(Optional) The username.
»EtcdV3BackendProps
Stores the state in the etcd KV store with a given prefix.
This backend supports state locking.
Read more about this backend in the Terraform docs: https://www.terraform.io/language/settings/backends/etcdv3
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Endpoints | string[] | (Required) The list of 'etcd' endpoints which to connect to. |
CacertPath | string | (Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers. |
CertPath | string | (Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification. |
KeyPath | string | (Optional) The path to a PEM-encoded key to provide to etcd for secure client identification. |
Lock | bool | (Optional) Whether to lock state access. |
Password | string | (Optional) Password used to connect to the etcd cluster. |
Prefix | string | (Optional) An optional prefix to be added to keys when to storing state in etcd. |
Username | string | (Optional) Username used to connect to the etcd cluster. |
»Endpoints
Required
- Type: string[]
(Required) The list of 'etcd' endpoints which to connect to.
»CacertPath
Optional
- Type: string
(Optional) The path to a PEM-encoded CA bundle with which to verify certificates of TLS-enabled etcd servers.
»CertPath
Optional
- Type: string
(Optional) The path to a PEM-encoded certificate to provide to etcd for secure client identification.
»KeyPath
Optional
- Type: string
(Optional) The path to a PEM-encoded key to provide to etcd for secure client identification.
»Lock
Optional
- Type: bool
(Optional) Whether to lock state access.
Defaults to true.
»Password
Optional
- Type: string
(Optional) Password used to connect to the etcd cluster.
»Prefix
Optional
- Type: string
(Optional) An optional prefix to be added to keys when to storing state in etcd.
Defaults to "".
»Username
Optional
- Type: string
(Optional) Username used to connect to the etcd cluster.
»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://www.terraform.io/language/resources/provisioners/file file}
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Destination | string | The source file or directory. |
Type | string | No description. |
Connection | object | 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
- Type: object
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.
»GcsBackendProps
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://www.terraform.io/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. |
Prefix | string | (Optional) GCS prefix inside the bucket. |
»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.
»Prefix
Optional
- Type: string
(Optional) GCS prefix inside the bucket.
Named states for workspaces are stored in an object called < prefix >/< name >.tfstate.
»HttpBackendProps
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://www.terraform.io/language/settings/backends/http
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Address | string | (Required) The address of the REST endpoint. |
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 | double | (Optional) The number of HTTP request retries. |
RetryWaitMax | double | (Optional) The maximum time in seconds to wait between HTTP request attempts. |
RetryWaitMin | double | (Optional) The minimum time in seconds to wait between HTTP request attempts. |
SkipCertVerification | bool | (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.
»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: double
(Optional) The number of HTTP request retries.
Defaults to 2.
»RetryWaitMax
Optional
- Type: double
(Optional) The maximum time in seconds to wait between HTTP request attempts.
Defaults to 30.
»RetryWaitMin
Optional
- Type: double
(Optional) The minimum time in seconds to wait between HTTP request attempts.
Defaults to 1.
»SkipCertVerification
Optional
- Type: bool
(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 | bool | 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: bool
- 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 | bool | 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: bool
- 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.
»LocalBackendProps
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://www.terraform.io/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://www.terraform.io/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 | System.Collections.Generic.IDictionary< 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: System.Collections.Generic.IDictionary< 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.
»MantaBackendProps
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Account | string | No description. |
KeyId | string | No description. |
Path | string | No description. |
InsecureSkipTlsVerify | bool | No description. |
KeyMaterial | string | No description. |
ObjectName | string | No description. |
Url | string | No description. |
User | string | No description. |
»Account
Required
- Type: string
»KeyId
Required
- Type: string
»Path
Required
- Type: string
»InsecureSkipTlsVerify
Optional
- Type: bool
»KeyMaterial
Optional
- Type: string
»ObjectName
Optional
- Type: string
»Url
Optional
- Type: string
»User
Optional
- Type: string
»OssAssumeRole
»Initializer
»Properties
Name | Type | Description |
---|---|---|
RoleArn | string | No description. |
Policy | string | No description. |
SessionExpiration | double | No description. |
SessionName | string | No description. |
»RoleArn
Required
- Type: string
»Policy
Optional
- Type: string
»SessionExpiration
Optional
- Type: double
»SessionName
Optional
- Type: string
»OssBackendProps
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Bucket | string | No description. |
AccessKey | string | No description. |
Acl | string | No description. |
AssumeRole | OssAssumeRole | No description. |
EcsRoleName | string | No description. |
Encrypt | bool | No description. |
Endpoint | string | No description. |
Key | string | No description. |
Prefix | string | No description. |
Profile | string | No description. |
Region | string | No description. |
SecretKey | string | No description. |
SecurityToken | string | No description. |
SharedCredentialsFile | string | No description. |
TablestoreEndpoint | string | No description. |
TablestoreTable | string | No description. |
»Bucket
Required
- Type: string
»AccessKey
Optional
- Type: string
»Acl
Optional
- Type: string
»AssumeRole
Optional
- Type: OssAssumeRole
»EcsRoleName
Optional
- Type: string
»Encrypt
Optional
- Type: bool
»Endpoint
Optional
- Type: string
»Key
Optional
- Type: string
»Prefix
Optional
- Type: string
»Profile
Optional
- Type: string
»Region
Optional
- Type: string
»SecretKey
Optional
- Type: string
»SecurityToken
Optional
- Type: string
»SharedCredentialsFile
Optional
- Type: string
»TablestoreEndpoint
Optional
- Type: string
»TablestoreTable
Optional
- Type: string
»PgBackendProps
»Initializer
»Properties
Name | Type | Description |
---|---|---|
ConnStr | string | No description. |
SchemaName | string | No description. |
SkipSchemaCreation | bool | No description. |
»ConnStr
Required
- Type: string
»SchemaName
Optional
- Type: string
»SkipSchemaCreation
Optional
- Type: bool
»RemoteBackendProps
»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://www.terraform.io/language/resources/provisioners/remote-exec remote-exec}
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Type | string | No description. |
Connection | object | 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
- Type: object
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 | bool | 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: bool
- Default: false
Whether the resolution is being executed during the prepare phase or not.
»S3BackendProps
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://www.terraform.io/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. |
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 | System.Collections.Generic.IDictionary< 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. |
DynamodbEndpoint | string | (Optional) Custom endpoint for the AWS DynamoDB API. |
DynamodbTable | string | (Optional) Name of DynamoDB Table to use for state locking and consistency. |
Encrypt | bool | (Optional) Enable server side encryption of the state file. |
Endpoint | string | (Optional) Custom endpoint for the AWS S3 API. |
ExternalId | string | (Optional) External identifier to use when assuming the role. |
ForcePathStyle | bool | (Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >). |
IamEndpoint | string | (Optional) Custom endpoint for the AWS Identity and Access Management (IAM) API. |
KmsKeyId | string | (Optional) Amazon Resource Name (ARN) of a Key Management Service (KMS) Key to use for encrypting the state. |
MaxRetries | double | (Optional) The maximum number of times an AWS API request is retried on retryable failure. |
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). |
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. |
SharedCredentialsFile | string | (Optional) Path to the AWS shared credentials file. |
SkipCredentialsValidation | bool | (Optional) Skip credentials validation via the STS API. |
SkipMetadataApiCheck | bool | (Optional) Skip usage of EC2 Metadata API. |
SkipRegionValidation | bool | (Optional) Skip validation of provided region name. |
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. |
Token | string | (Optional) Multi-Factor Authentication (MFA) token. |
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.
»AssumeRolePolicy
Optional
- Type: string
(Optional) IAM Policy JSON describing further restricting permissions for the IAM Role being assumed.
»AssumeRolePolicyArns
Optional
- Type: string[]
(Optional) Set of Amazon Resource Names (ARNs) of IAM Policies describing further restricting permissions for the IAM Role being assumed.
»AssumeRoleTags
Optional
- Type: System.Collections.Generic.IDictionary< string, string >
(Optional) Map of assume role session tags.
»AssumeRoleTransitiveTagKeys
Optional
- Type: string[]
(Optional) Set of assume role session tag keys to pass to any subsequent sessions.
»DynamodbEndpoint
Optional
- 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.
»Encrypt
Optional
- Type: bool
(Optional) Enable server side encryption of the state file.
»Endpoint
Optional
- Type: string
(Optional) Custom endpoint for the AWS S3 API.
This can also be sourced from the AWS_S3_ENDPOINT environment variable.
»ExternalId
Optional
- Type: string
(Optional) External identifier to use when assuming the role.
»ForcePathStyle
Optional
- Type: bool
(Optional) Enable path-style S3 URLs (https://< HOST >/< BUCKET > instead of https://< BUCKET >.< HOST >).
»IamEndpoint
Optional
- 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.
»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: double
(Optional) The maximum number of times an AWS API request is retried on retryable failure.
Defaults to 5.
»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.
»RoleArn
Optional
- 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
- Type: string
(Optional) Session name to use when assuming the role.
»SharedCredentialsFile
Optional
- Type: string
(Optional) Path to the AWS shared credentials file.
Defaults to ~/.aws/credentials.
»SkipCredentialsValidation
Optional
- Type: bool
(Optional) Skip credentials validation via the STS API.
»SkipMetadataApiCheck
Optional
- Type: bool
(Optional) Skip usage of EC2 Metadata API.
»SkipRegionValidation
Optional
- Type: bool
(Optional) Skip validation of provided region name.
»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
- 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.
»Token
Optional
- Type: string
(Optional) Multi-Factor Authentication (MFA) token.
This can also be sourced from the AWS_SESSION_TOKEN environment variable.
»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:
»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.
See {@link https://www.terraform.io/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 | double | 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 | double | 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 | double | 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: double
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: double
- 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: double
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://www.terraform.io/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. |
SynthesizedStackPath | string | No description. |
WorkingDirectory | string | No description. |
»Annotations
Required
- Type: StackAnnotation[]
»ConstructPath
Required
- Type: string
»Dependencies
Required
- Type: string[]
»Name
Required
- Type: string
»SynthesizedStackPath
Required
- Type: string
»WorkingDirectory
Required
- Type: string
»SwiftBackendProps
»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 | bool | 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
- Type: string
»ApplicationCredentialId
Optional
- Type: string
»ApplicationCredentialName
Optional
- Type: string
»ApplicationCredentialSecret
Optional
- Type: string
»ArchiveContainer
Optional
- Type: string
»AuthUrl
Optional
- Type: string
»CacertFile
Optional
- Type: string
»Cert
Optional
- Type: string
»Cloud
Optional
- Type: string
»DefaultDomain
Optional
- Type: string
»DomainId
Optional
- Type: string
»DomainName
Optional
- Type: string
»ExpireAfter
Optional
- Type: string
»Insecure
Optional
- Type: bool
»Key
Optional
- Type: string
»Password
Optional
- Type: string
»ProjectDomainId
Optional
- Type: string
»ProjectDomainName
Optional
- Type: string
»RegionName
Optional
- Type: string
»StateName
Optional
- Type: string
»TenantId
Optional
- Type: string
»TenantName
Optional
- Type: string
»Token
Optional
- Type: string
»UserDomainId
Optional
- Type: string
»UserDomainName
Optional
- Type: string
»UserId
Optional
- Type: string
»UserName
Optional
- 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
»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
»TerraformHclModuleOptions
»Initializer
»Properties
Name | Type | Description |
---|---|---|
DependsOn | ITerraformDependable[] | No description. |
ForEach | ITerraformIterator | No description. |
Providers | object[] | No description. |
SkipAssetCreationFromLocalModules | bool | No description. |
Source | string | No description. |
Version | string | No description. |
Variables | System.Collections.Generic.IDictionary< string, object > | No description. |
»DependsOn
Optional
- Type: ITerraformDependable[]
»ForEach
Optional
- Type: ITerraformIterator
»Providers
Optional
- Type: object[]
»SkipAssetCreationFromLocalModules
Optional
- Type: bool
»Source
Required
- Type: string
»Version
Optional
- Type: string
»Variables
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»TerraformMetaArguments
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Connection | object | No description. |
Count | double | No description. |
DependsOn | ITerraformDependable[] | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Provisioners | object[] | No description. |
»Connection
Optional
- Type: object
»Count
Optional
- Type: double
»DependsOn
Optional
- Type: ITerraformDependable[]
»ForEach
Optional
- Type: ITerraformIterator
»Lifecycle
Optional
»Provider
Optional
- Type: TerraformProvider
»Provisioners
Optional
- Type: object[]
»TerraformModuleOptions
»Initializer
»Properties
Name | Type | Description |
---|---|---|
DependsOn | ITerraformDependable[] | No description. |
ForEach | ITerraformIterator | No description. |
Providers | object[] | No description. |
SkipAssetCreationFromLocalModules | bool | No description. |
Source | string | No description. |
Version | string | No description. |
»DependsOn
Optional
- Type: ITerraformDependable[]
»ForEach
Optional
- Type: ITerraformIterator
»Providers
Optional
- Type: object[]
»SkipAssetCreationFromLocalModules
Optional
- Type: bool
»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
»TerraformModuleUserOptions
»Initializer
»Properties
Name | Type | Description |
---|---|---|
DependsOn | ITerraformDependable[] | No description. |
ForEach | ITerraformIterator | No description. |
Providers | object[] | No description. |
SkipAssetCreationFromLocalModules | bool | No description. |
»DependsOn
Optional
- Type: ITerraformDependable[]
»ForEach
Optional
- Type: ITerraformIterator
»Providers
Optional
- Type: object[]
»SkipAssetCreationFromLocalModules
Optional
- Type: bool
»TerraformOutputConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Value | object | No description. |
DependsOn | ITerraformDependable[] | No description. |
Description | string | No description. |
Sensitive | bool | No description. |
StaticId | bool | 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: object
»DependsOn
Optional
- Type: ITerraformDependable[]
»Description
Optional
- Type: string
»Sensitive
Optional
- Type: bool
»StaticId
Optional
- Type: bool
- 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 | object | No description. |
Count | double | No description. |
DependsOn | ITerraformDependable[] | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Provisioners | object[] | No description. |
TerraformResourceType | string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
»Connection
Optional
- Type: object
»Count
Optional
- Type: double
»DependsOn
Optional
- Type: ITerraformDependable[]
»ForEach
Optional
- Type: ITerraformIterator
»Lifecycle
Optional
»Provider
Optional
- Type: TerraformProvider
»Provisioners
Optional
- Type: object[]
»TerraformResourceType
Required
- Type: string
»TerraformGeneratorMetadata
Optional
»TerraformResourceLifecycle
»Initializer
»Properties
Name | Type | Description |
---|---|---|
CreateBeforeDestroy | bool | No description. |
IgnoreChanges | object | No description. |
PreventDestroy | bool | No description. |
»CreateBeforeDestroy
Optional
- Type: bool
»IgnoreChanges
Optional
- Type: object
»PreventDestroy
Optional
- Type: bool
»TerraformStackMetadata
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Backend | string | No description. |
StackName | string | No description. |
Version | string | No description. |
»Backend
Required
- Type: string
»StackName
Required
- Type: string
»Version
Required
- Type: string
»TerraformVariableConfig
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Default | object | No description. |
Description | string | No description. |
Nullable | bool | No description. |
Sensitive | bool | 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: object
»Description
Optional
- Type: string
»Nullable
Optional
- Type: bool
»Sensitive
Optional
- Type: bool
»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, see {@link https://www.terraform.io/docs/configuration/types.html|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
»Initializer
»Properties
Name | Type | Description |
---|---|---|
Condition | object | No description. |
ErrorMessage | string | No description. |
»Condition
Required
- Type: object
»ErrorMessage
Required
- Type: string
»TestingAppOptions
»Initializer
»Properties
Name | Type | Description |
---|---|---|
EnableFutureFlags | bool | No description. |
FakeCdktfJsonPath | bool | No description. |
Outdir | string | No description. |
StackTraces | bool | No description. |
StubVersion | bool | No description. |
»EnableFutureFlags
Optional
- Type: bool
»FakeCdktfJsonPath
Optional
- Type: bool
»Outdir
Optional
- Type: string
»StackTraces
Optional
- Type: bool
»StubVersion
Optional
- Type: bool
»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://www.terraform.io/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 | bool | Set to true to connect using HTTPS instead of HTTP. |
Insecure | bool | Set to true to skip validating the HTTPS certificate chain. |
Password | string | The password to use for the connection. |
Port | double | 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 | bool | 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: bool
Set to true to connect using HTTPS instead of HTTP.
»Insecure
Optional
- Type: bool
Set to true to skip validating the HTTPS certificate chain.
»Password
Optional
- Type: string
The password to use for the connection.
»Port
Optional
- Type: double
- 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://www.terraform.io/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: bool
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.
»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
- Implements: ITerraformAddressable, IInterpolatingParent, IResolvable
»Initializers
Name | Type | Description |
---|---|---|
TerraformResource | IInterpolatingParent | No description. |
TerraformAttribute | string | No description. |
WrapsSet | bool | No description. |
»TerraformResource
Required
- Type: IInterpolatingParent
»TerraformAttribute
Required
- Type: string
»WrapsSet
Required
- Type: bool
»Methods
Name | Description |
---|---|
ComputeFqn | No description. |
Get | No description. |
InterpolationForAttribute | No description. |
Resolve | Produce the Token's value at resolution time. |
ToString | Return a string representation of this resolvable object. |
»ComputeFqn
»Get
»Index
Required
- Type: double
»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
»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
Name | Type | Description |
---|---|---|
All | IAspect[] | The list of aspects which were directly applied on this scope. |
»All
Required
- Type: IAspect[]
The list of aspects which were directly applied on this scope.
»AssertionReturn
»Initializers
Name | Type | Description |
---|---|---|
Message | string | No description. |
Pass | bool | No description. |
»Message
Required
- Type: string
»Pass
Required
- Type: bool
»Properties
Name | Type | Description |
---|---|---|
Message | string | No description. |
Pass | bool | No description. |
»Message
Required
- Type: string
»Pass
Required
- Type: bool
»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
- Implements: ITerraformAddressable, IInterpolatingParent, IResolvable
»Initializers
Name | Type | Description |
---|---|---|
TerraformResource | IInterpolatingParent | No description. |
TerraformAttribute | string | No description. |
WrapsSet | bool | No description. |
»TerraformResource
Required
- Type: IInterpolatingParent
»TerraformAttribute
Required
- Type: string
»WrapsSet
Required
- Type: bool
»Methods
Name | Description |
---|---|
ComputeFqn | No description. |
Get | No description. |
InterpolationForAttribute | No description. |
Resolve | Produce the Token's value at resolution time. |
ToString | Return a string representation of this resolvable object. |
»ComputeFqn
»Get
»Index
Required
- Type: double
»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
»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 | bool | No description. |
»TerraformResource
Required
- Type: IInterpolatingParent
»TerraformAttribute
Required
- Type: string
»ComplexComputedListIndex
Required
- Type: string
»WrapsSet
Optional
- Type: bool
»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 | bool | No description. |
»TerraformResource
Required
- Type: IInterpolatingParent
»TerraformAttribute
Required
- Type: string
»WrapsSet
Required
- Type: bool
»Methods
Name | Description |
---|---|
ComputeFqn | No description. |
Resolve | Produce the Token's value at resolution time. |
ToString | Return a string representation of this resolvable object. |
»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. |
Resolve | Produce the Token's value at resolution time. |
ToString | Return a string representation of this resolvable object. |
»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
»ComplexObject
- Implements: IInterpolatingParent, IResolvable, ITerraformAddressable
»Initializers
Name | Type | Description |
---|---|---|
TerraformResource | IInterpolatingParent | No description. |
TerraformAttribute | string | No description. |
ComplexObjectIsFromSet | bool | 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 | object | the index of the complex object in a list. |
»TerraformResource
Required
- Type: IInterpolatingParent
»TerraformAttribute
Required
- Type: string
»ComplexObjectIsFromSet
Required
- Type: bool
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: object
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: System.Collections.Generic.IDictionary< string, object >
»Context
Required
- Type: IResolveContext
»ResolveNumberList
Resolves a list of numbers.
»Xs
Required
- Type: double[]
»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
»Fn
»Initializers
Name | Type | Description |
---|
»Static Functions
Name | Description |
---|---|
Abs | {@link https://www.terraform.io/docs/language/functions/abs.html abs} returns the absolute value of the given number. |
Abspath | {@link https://www.terraform.io/docs/language/functions/abspath.html abspath} takes a string containing a filesystem path and converts it to an absolute path. |
Alltrue | {@link https://www.terraform.io/docs/language/functions/alltrue.html alltrue} returns true if all elements in a given collection are true or "true". |
Anytrue | {@link https://www.terraform.io/docs/language/functions/anytrue.html anytrue} returns true if any element in a given collection is true or "true". |
Base64decode | {@link https://www.terraform.io/docs/language/functions/base64decode.html base64decode} takes a string containing a Base64 character sequence and returns the original string. |
Base64encode | {@link https://www.terraform.io/docs/language/functions/base64encode.html base64encode} takes a string containing a Base64 character sequence and returns the original string. |
Base64gzip | {@link https://www.terraform.io/docs/language/functions/base64gzip.html base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding. |
Base64sha256 | {@link https://www.terraform.io/docs/language/functions/base64sha256.html base64sha256} computes the SHA256 hash of a given string and encodes it with Base64. |
Base64sha512 | {@link https://www.terraform.io/docs/language/functions/base64sha512.html base64sha512} computes the SHA512 hash of a given string and encodes it with Base64. |
Basename | {@link https://www.terraform.io/docs/language/functions/basename.html basename} takes a string containing a filesystem path and removes all except the last portion from it. |
Bcrypt | {@link https://www.terraform.io/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. |
Can | {@link https://www.terraform.io/docs/language/functions/can.html can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors. |
Ceil | {@link https://www.terraform.io/docs/language/functions/ceil.html ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction. |
Chomp | {@link https://www.terraform.io/docs/language/functions/chomp.html chomp} removes newline characters at the end of a string. |
Chunklist | {@link https://www.terraform.io/docs/language/functions/chunklist.html chunklist} splits a single list into fixed-size chunks, returning a list of lists. |
Cidrhost | {@link https://www.terraform.io/docs/language/functions/cidrhost.html cidrhost} calculates a full host IP address for a given host number within a given IP network address prefix. |
Cidrnetmask | {@link https://www.terraform.io/docs/language/functions/cidrnetmask.html cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address. |
Cidrsubnet | {@link https://www.terraform.io/docs/language/functions/cidrsubnet.html cidrsubnet} calculates a subnet address within given IP network address prefix. |
Cidrsubnets | {@link https://www.terraform.io/docs/language/functions/cidrsubnets.html cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix. |
Coalesce | {@link https://www.terraform.io/docs/language/functions/coalesce.html coalesce} takes any number of arguments and returns the first one that isn't null or an empty string. |
Coalescelist | {@link https://www.terraform.io/docs/language/functions/coalescelist.html coalescelist} takes any number of list arguments and returns the first one that isn't empty. |
Compact | {@link https://www.terraform.io/docs/language/functions/compact.html compact} takes a list of strings and returns a new list with any empty string elements removed. |
Concat | {@link https://www.terraform.io/docs/language/functions/concat.html concat} takes two or more lists and combines them into a single list. |
Contains | {@link https://www.terraform.io/docs/language/functions/contains.html contains} determines whether a given list or set contains a given single value as one of its elements. |
Csvdecode | {@link https://www.terraform.io/docs/language/functions/csvdecode.html csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data. |
Dirname | {@link https://www.terraform.io/docs/language/functions/dirname.html dirname} takes a string containing a filesystem path and removes the last portion from it. |
Distinct | {@link https://www.terraform.io/docs/language/functions/distinct.html distinct} takes a list and returns a new list with any duplicate elements removed. |
Element | {@link https://www.terraform.io/docs/language/functions/element.html element} retrieves a single element from a list. |
File | {@link https://www.terraform.io/docs/language/functions/file.html file} takes a string containing a filesystem path and removes all except the last portion from it. |
Filebase64 | {@link https://www.terraform.io/docs/language/functions/filebase64.html filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string. |
Filebase64sha256 | {@link https://www.terraform.io/docs/language/functions/filebase64sha256.html filebase64sha256} is a variant of base64sha256 that hashes the contents of a given file rather than a literal string. |
Filebase64sha512 | {@link https://www.terraform.io/docs/language/functions/filebase64sha512.html filebase64sha512} is a variant of base64sha512 that hashes the contents of a given file rather than a literal string. |
Fileexists | {@link https://www.terraform.io/docs/language/functions/fileexists.html fileexists} determines whether a file exists at a given path. |
Filemd5 | {@link https://www.terraform.io/docs/language/functions/filemd5.html filemd5} is a variant of md5 that hashes the contents of a given file rather than a literal string. |
Fileset | {@link https://www.terraform.io/docs/language/functions/fileset.html fileset} enumerates a set of regular file names given a path and pattern. |
Filesha1 | {@link https://www.terraform.io/docs/language/functions/filesha1.html filesha1} is a variant of sha1 that hashes the contents of a given file rather than a literal string. |
Filesha256 | {@link https://www.terraform.io/docs/language/functions/filesha256.html filesha256} is a variant of sha256 that hashes the contents of a given file rather than a literal string. |
Filesha512 | {@link https://www.terraform.io/docs/language/functions/filesha512.html filesha512} is a variant of sha512 that hashes the contents of a given file rather than a literal string. |
Flatten | {@link https://www.terraform.io/docs/language/functions/flatten.html flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents. |
Floor | {@link https://www.terraform.io/docs/language/functions/floor.html floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction. |
Format | {@link https://www.terraform.io/docs/language/functions/format.html format} produces a string by formatting a number of other values according to a specification string. |
Formatdate | {@link https://www.terraform.io/docs/language/functions/formatdate.html formatdate} converts a timestamp into a different time format. |
Formatlist | {@link https://www.terraform.io/docs/language/functions/formatlist.html formatlist} produces a list of strings by formatting a number of other values according to a specification string. |
Indent | {@link https://www.terraform.io/docs/language/functions/indent.html 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://www.terraform.io/docs/language/functions/index.html index} finds the element index for a given value in a list. |
Join | {@link https://www.terraform.io/docs/language/functions/join.html join} produces a string by concatenating together all elements of a given list of strings with the given delimiter. |
Jsondecode | {@link https://www.terraform.io/docs/language/functions/jsondecode.html jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string. |
Jsonencode | {@link https://www.terraform.io/docs/language/functions/jsonencode.html jsonencode} encodes a given value to a string using JSON syntax. |
Keys | {@link https://www.terraform.io/docs/language/functions/keys.html keys} takes a map and returns a list containing the keys from that map. |
LengthOf | {@link https://www.terraform.io/docs/language/functions/length.html length} determines the length of a given list, map, or string. |
Log | {@link https://www.terraform.io/docs/language/functions/log.html log} returns the logarithm of a given number in a given base. |
Lookup | {@link https://www.terraform.io/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. |
Lower | {@link https://www.terraform.io/docs/language/functions/lower.html lower} converts all cased letters in the given string to lowercase. |
Matchkeys | {@link https://www.terraform.io/docs/language/functions/matchkeys.html 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://www.terraform.io/docs/language/functions/max.html max} takes one or more numbers and returns the greatest number from the set. |
Md5 | {@link https://www.terraform.io/docs/language/functions/md5.html md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits. |
MergeLists | {@link https://www.terraform.io/docs/language/functions/merge.html 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. |
MergeMaps | {@link https://www.terraform.io/docs/language/functions/merge.html 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://www.terraform.io/docs/language/functions/min.html min} takes one or more numbers and returns the smallest number from the set. |
Nonsensitive | {@link https://www.terraform.io/docs/language/functions/nonsensitive.html 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://www.terraform.io/docs/language/functions/one.html one} takes a list, set, or tuple value with either zero or one elements. |
ParseInt | {@link https://www.terraform.io/docs/language/functions/parseint.html 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://www.terraform.io/docs/language/functions/pathexpand.html pathexpand} takes a string containing a filesystem path and removes the last portion from it. |
Pow | {@link https://www.terraform.io/docs/language/functions/pow.html pow} calculates an exponent, by raising its first argument to the power of the second argument. |
Range | {@link https://www.terraform.io/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). |
Regex | {@link https://www.terraform.io/docs/language/functions/regex.html regex} applies a regular expression to a string and returns the matching substrings in pattern. |
Regexall | {@link https://www.terraform.io/docs/language/functions/regexall.html regexall} applies a regular expression to a string and returns a list of all matches. |
Replace | {@link https://www.terraform.io/docs/language/functions/replace.html replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string. |
Reverse | {@link https://www.terraform.io/docs/language/functions/reverse.html 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://www.terraform.io/docs/language/functions/rsadecrypt.html rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext. |
Sensitive | {@link https://www.terraform.io/docs/language/functions/sensitive.html 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 | {@link https://www.terraform.io/docs/language/functions/setintersection.html setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common. |
Setproduct | {@link https://www.terraform.io/docs/language/functions/setproduct.html setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product. |
Setsubtract | {@link https://www.terraform.io/docs/language/functions/slice.html setsubtract} function returns a new set containing the elements from the first set that are not present in the second set. |
Setunion | {@link https://www.terraform.io/docs/language/functions/setunion.html setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets. |
Sha1 | {@link https://www.terraform.io/docs/language/functions/sha1.html sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits. |
Sha256 | {@link https://www.terraform.io/docs/language/functions/sha256.html sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits. |
Sha512 | {@link https://www.terraform.io/docs/language/functions/sha512.html sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits. |
Signum | {@link https://www.terraform.io/docs/language/functions/signum.html signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign. |
Slice | {@link https://www.terraform.io/docs/language/functions/slice.html slice} extracts some consecutive elements from within a list. |
Sort | {@link https://www.terraform.io/docs/language/functions/sort.html sort} takes a list of strings and returns a new list with those strings sorted lexicographically. |
Split | {@link https://www.terraform.io/docs/language/functions/split.html split} produces a list by dividing a given string at all occurrences of a given separator. |
Strrev | {@link https://www.terraform.io/docs/language/functions/strrev.html strrev} reverses the characters in a string. |
Substr | {@link https://www.terraform.io/docs/language/functions/substr.html substr} extracts a substring from a given string by offset and length. |
Sum | {@link https://www.terraform.io/docs/language/functions/sum.html sum} takes a list or set of numbers and returns the sum of those numbers. |
Templatefile | {@link https://www.terraform.io/docs/language/functions/templatefile.html 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://www.terraform.io/docs/language/functions/textdecodebase64.html 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://www.terraform.io/docs/language/functions/textencodebase64.html 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://www.terraform.io/docs/language/functions/timeadd.html timeadd} adds a duration to a timestamp, returning a new timestamp. |
Timestamp | {@link https://www.terraform.io/docs/language/functions/timestamp.html timestamp} returns a UTC timestamp string in RFC 3339 format. |
Title | {@link https://www.terraform.io/docs/language/functions/title.html title} converts the first letter of each word in the given string to uppercase. |
Tobool | {@link https://www.terraform.io/docs/language/functions/tobool.html tobool} converts its argument to a boolean value. |
Tolist | {@link https://www.terraform.io/docs/language/functions/tolist.html tolist} converts its argument to a list value. |
Tomap | {@link https://www.terraform.io/docs/language/functions/tomap.html tomap} converts its argument to a map value. |
Tonumber | {@link https://www.terraform.io/docs/language/functions/tonumber.html tonumber} converts its argument to a number value. |
Toset | {@link https://www.terraform.io/docs/language/functions/toset.html toset} converts its argument to a set value. |
Tostring | {@link https://www.terraform.io/docs/language/functions/tostring.html tostring} converts its argument to a string value. |
Transpose | {@link https://www.terraform.io/docs/language/functions/transpose.html 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://www.terraform.io/docs/language/functions/trim.html trim} removes the specified characters from the start and end of the given string. |
Trimprefix | {@link https://www.terraform.io/docs/language/functions/trimprefix.html trimprefix} removes the specified prefix from the start of the given string. |
Trimspace | {@link https://www.terraform.io/docs/language/functions/trimspace.html trimspace} removes any space characters from the start and end of the given string. |
Trimsuffix | {@link https://www.terraform.io/docs/language/functions/trimsuffix.html trimsuffix} removes the specified suffix from the end of the given string. |
Try | {@link https://www.terraform.io/docs/language/functions/try.html 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://www.terraform.io/docs/language/functions/upper.html upper} converts all cased letters in the given string to uppercase. |
Urlencode | {@link https://www.terraform.io/docs/language/functions/urlencode.html urlencode} applies URL encoding to a given string. |
Uuid | {@link https://www.terraform.io/docs/language/functions/uuid.html uuid} generates a unique identifier string. |
Uuidv5 | {@link https://www.terraform.io/docs/language/functions/uuidv5.html uuidv5} generates a unique identifier string. |
Values | {@link https://www.terraform.io/docs/language/functions/values.html values} takes a map and returns a list containing the values of the elements in that map. |
Yamldecode | {@link https://www.terraform.io/docs/language/functions/yamldecode.html yamldecode} parses a string as a subset of YAML, and produces a representation of its value. |
Yamlencode | {@link https://www.terraform.io/docs/language/functions/yamlencode.html yamlencode} encodes a given value to a string using JSON syntax. |
Zipmap | {@link https://www.terraform.io/docs/language/functions/zipmap.html zipmap} constructs a map from a list of keys and a corresponding list of values. |
»Abs
{@link https://www.terraform.io/docs/language/functions/abs.html abs} returns the absolute value of the given number.
»Value
Required
- Type: double
»Abspath
{@link https://www.terraform.io/docs/language/functions/abspath.html abspath} takes a string containing a filesystem path and converts it to an absolute path.
»Value
Required
- Type: string
»Alltrue
{@link https://www.terraform.io/docs/language/functions/alltrue.html alltrue} returns true if all elements in a given collection are true or "true".
»Values
Required
- Type: object[]
»Anytrue
{@link https://www.terraform.io/docs/language/functions/anytrue.html anytrue} returns true if any element in a given collection is true or "true".
»Value
Required
- Type: object[]
»Base64decode
{@link https://www.terraform.io/docs/language/functions/base64decode.html base64decode} takes a string containing a Base64 character sequence and returns the original string.
»Value
Required
- Type: string
»Base64encode
{@link https://www.terraform.io/docs/language/functions/base64encode.html base64encode} takes a string containing a Base64 character sequence and returns the original string.
»Value
Required
- Type: string
»Base64gzip
{@link https://www.terraform.io/docs/language/functions/base64gzip.html base64gzip} compresses a string with gzip and then encodes the result in Base64 encoding.
»Value
Required
- Type: string
»Base64sha256
{@link https://www.terraform.io/docs/language/functions/base64sha256.html base64sha256} computes the SHA256 hash of a given string and encodes it with Base64.
»Value
Required
- Type: string
»Base64sha512
{@link https://www.terraform.io/docs/language/functions/base64sha512.html base64sha512} computes the SHA512 hash of a given string and encodes it with Base64.
»Value
Required
- Type: string
»Basename
{@link https://www.terraform.io/docs/language/functions/basename.html basename} takes a string containing a filesystem path and removes all except the last portion from it.
»Value
Required
- Type: string
»Bcrypt
{@link https://www.terraform.io/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.
»Value
Required
- Type: string
»Cost
Optional
- Type: double
»Can
{@link https://www.terraform.io/docs/language/functions/can.html can} evaluates the given expression and returns a boolean value indicating whether the expression produced a result without any errors.
»Expression
Required
- Type: object
»Ceil
{@link https://www.terraform.io/docs/language/functions/ceil.html ceil} returns the closest whole number that is greater than or equal to the given value, which may be a fraction.
»Value
Required
- Type: double
»Chomp
{@link https://www.terraform.io/docs/language/functions/chomp.html chomp} removes newline characters at the end of a string.
»Value
Required
- Type: string
»Chunklist
{@link https://www.terraform.io/docs/language/functions/chunklist.html chunklist} splits a single list into fixed-size chunks, returning a list of lists.
»Value
Required
- Type: object[]
»ChunkSize
Required
- Type: double
»Cidrhost
{@link https://www.terraform.io/docs/language/functions/cidrhost.html 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: double
»Cidrnetmask
{@link https://www.terraform.io/docs/language/functions/cidrnetmask.html cidrnetmask} converts an IPv4 address prefix given in CIDR notation into a subnet mask address.
»Prefix
Required
- Type: string
»Cidrsubnet
{@link https://www.terraform.io/docs/language/functions/cidrsubnet.html cidrsubnet} calculates a subnet address within given IP network address prefix.
»Prefix
Required
- Type: string
»Newbits
Required
- Type: double
»Netnum
Required
- Type: double
»Cidrsubnets
{@link https://www.terraform.io/docs/language/functions/cidrsubnets.html cidrsubnets} calculates a sequence of consecutive IP address ranges within a particular CIDR prefix.
»Prefix
Required
- Type: string
»Newbits
Required
- Type: double[]
»Coalesce
{@link https://www.terraform.io/docs/language/functions/coalesce.html coalesce} takes any number of arguments and returns the first one that isn't null or an empty string.
»Value
Required
- Type: object[]
Arguments are passed in an array.
»Coalescelist
{@link https://www.terraform.io/docs/language/functions/coalescelist.html coalescelist} takes any number of list arguments and returns the first one that isn't empty.
»Value
Required
- Type: object[][]
Arguments are passed in an array.
»Compact
{@link https://www.terraform.io/docs/language/functions/compact.html compact} takes a list of strings and returns a new list with any empty string elements removed.
»Value
Required
- Type: string[]
»Concat
{@link https://www.terraform.io/docs/language/functions/concat.html concat} takes two or more lists and combines them into a single list.
»Value
Required
- Type: object[][]
»Contains
{@link https://www.terraform.io/docs/language/functions/contains.html contains} determines whether a given list or set contains a given single value as one of its elements.
»List
Required
- Type: object
»Value
Required
- Type: object
»Csvdecode
{@link https://www.terraform.io/docs/language/functions/csvdecode.html csvdecode} decodes a string containing CSV-formatted data and produces a list of maps representing that data.
»Value
Required
- Type: string
»Dirname
{@link https://www.terraform.io/docs/language/functions/dirname.html dirname} takes a string containing a filesystem path and removes the last portion from it.
»Value
Required
- Type: string
»Distinct
{@link https://www.terraform.io/docs/language/functions/distinct.html distinct} takes a list and returns a new list with any duplicate elements removed.
»List
Required
- Type: object
»Element
{@link https://www.terraform.io/docs/language/functions/element.html element} retrieves a single element from a list.
»List
Required
- Type: object
»Index
Required
- Type: double
»File
{@link https://www.terraform.io/docs/language/functions/file.html file} takes a string containing a filesystem path and removes all except the last portion from it.
»Value
Required
- Type: string
»Filebase64
{@link https://www.terraform.io/docs/language/functions/filebase64.html filebase64} reads the contents of a file at the given path and returns them as a base64-encoded string.
»Value
Required
- Type: string
»Filebase64sha256
{@link https://www.terraform.io/docs/language/functions/filebase64sha256.html filebase64sha256} is a variant of base64sha256 that hashes the contents of a given file rather than a literal string.
»Value
Required
- Type: string
»Filebase64sha512
{@link https://www.terraform.io/docs/language/functions/filebase64sha512.html filebase64sha512} is a variant of base64sha512 that hashes the contents of a given file rather than a literal string.
»Value
Required
- Type: string
»Fileexists
{@link https://www.terraform.io/docs/language/functions/fileexists.html fileexists} determines whether a file exists at a given path.
»Value
Required
- Type: string
»Filemd5
{@link https://www.terraform.io/docs/language/functions/filemd5.html filemd5} is a variant of md5 that hashes the contents of a given file rather than a literal string.
»Value
Required
- Type: string
»Fileset
{@link https://www.terraform.io/docs/language/functions/fileset.html fileset} enumerates a set of regular file names given a path and pattern.
»Path
Required
- Type: string
»Pattern
Required
- Type: string
»Filesha1
{@link https://www.terraform.io/docs/language/functions/filesha1.html filesha1} is a variant of sha1 that hashes the contents of a given file rather than a literal string.
»Value
Required
- Type: string
»Filesha256
{@link https://www.terraform.io/docs/language/functions/filesha256.html filesha256} is a variant of sha256 that hashes the contents of a given file rather than a literal string.
»Value
Required
- Type: string
»Filesha512
{@link https://www.terraform.io/docs/language/functions/filesha512.html filesha512} is a variant of sha512 that hashes the contents of a given file rather than a literal string.
»Value
Required
- Type: string
»Flatten
{@link https://www.terraform.io/docs/language/functions/flatten.html flatten} takes a list and replaces any elements that are lists with a flattened sequence of the list contents.
»List
Required
- Type: object
»Floor
{@link https://www.terraform.io/docs/language/functions/floor.html floor} returns the closest whole number that is less than or equal to the given value, which may be a fraction.
»Value
Required
- Type: double
»Format
{@link https://www.terraform.io/docs/language/functions/format.html format} produces a string by formatting a number of other values according to a specification string.
»Spec
Required
- Type: string
»Values
Required
- Type: object[]
»Formatdate
{@link https://www.terraform.io/docs/language/functions/formatdate.html formatdate} converts a timestamp into a different time format.
»Spec
Required
- Type: string
»Timestamp
Required
- Type: string
»Formatlist
{@link https://www.terraform.io/docs/language/functions/formatlist.html formatlist} produces a list of strings by formatting a number of other values according to a specification string.
»Spec
Required
- Type: string
»Values
Required
- Type: object[]
»Indent
{@link https://www.terraform.io/docs/language/functions/indent.html indent} adds a given number of spaces to the beginnings of all but the first line in a given multi-line string.
»Indentation
Required
- Type: double
»Value
Required
- Type: string
»Index
{@link https://www.terraform.io/docs/language/functions/index.html index} finds the element index for a given value in a list.
»List
Required
- Type: object
»Value
Required
- Type: object
»Join
{@link https://www.terraform.io/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
»Value
Required
- Type: string[]
»Jsondecode
{@link https://www.terraform.io/docs/language/functions/jsondecode.html jsondecode} interprets a given string as JSON, returning a representation of the result of decoding that string.
»Value
Required
- Type: string
»Jsonencode
{@link https://www.terraform.io/docs/language/functions/jsonencode.html jsonencode} encodes a given value to a string using JSON syntax.
»Value
Required
- Type: object
»Keys
{@link https://www.terraform.io/docs/language/functions/keys.html keys} takes a map and returns a list containing the keys from that map.
»Map
Required
- Type: object
»LengthOf
{@link https://www.terraform.io/docs/language/functions/length.html length} determines the length of a given list, map, or string.
»Value
Required
- Type: object
»Log
{@link https://www.terraform.io/docs/language/functions/log.html log} returns the logarithm of a given number in a given base.
»Value
Required
- Type: double
»Base
Required
- Type: double
»Lookup
{@link https://www.terraform.io/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.
»Value
Required
- Type: object
»Key
Required
- Type: object
»DefaultValue
Required
- Type: object
»Lower
{@link https://www.terraform.io/docs/language/functions/lower.html lower} converts all cased letters in the given string to lowercase.
»Value
Required
- Type: string
»Matchkeys
{@link https://www.terraform.io/docs/language/functions/matchkeys.html 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.
»ValuesList
Required
- Type: object
»KeysList
Required
- Type: object
»SearchSet
Required
- Type: object
»Max
{@link https://www.terraform.io/docs/language/functions/max.html max} takes one or more numbers and returns the greatest number from the set.
»Values
Required
- Type: double[]
»Md5
{@link https://www.terraform.io/docs/language/functions/md5.html md5} computes the MD5 hash of a given string and encodes it with hexadecimal digits.
»Value
Required
- Type: string
»MergeLists
{@link https://www.terraform.io/docs/language/functions/merge.html 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.
»Values
Required
- Type: object[]
Arguments are passed in an array.
»MergeMaps
{@link https://www.terraform.io/docs/language/functions/merge.html 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.
»Values
Required
- Type: object[]
Arguments are passed in an array.
»Min
{@link https://www.terraform.io/docs/language/functions/min.html min} takes one or more numbers and returns the smallest number from the set.
»Values
Required
- Type: double[]
»Nonsensitive
{@link https://www.terraform.io/docs/language/functions/nonsensitive.html nonsensitive} takes a sensitive value and returns a copy of that value with the sensitive marking removed, thereby exposing the sensitive value.
»Expression
Required
- Type: object
»One
{@link https://www.terraform.io/docs/language/functions/one.html one} takes a list, set, or tuple value with either zero or one elements.
»List
Required
- Type: object
»ParseInt
{@link https://www.terraform.io/docs/language/functions/parseint.html 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.
»Value
Required
- Type: string
»Base
Required
- Type: double
»Pathexpand
{@link https://www.terraform.io/docs/language/functions/pathexpand.html pathexpand} takes a string containing a filesystem path and removes the last portion from it.
»Value
Required
- Type: string
»Pow
{@link https://www.terraform.io/docs/language/functions/pow.html pow} calculates an exponent, by raising its first argument to the power of the second argument.
»Value
Required
- Type: double
»Power
Required
- Type: double
»Range
{@link https://www.terraform.io/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: double
»Limit
Required
- Type: double
»Step
Optional
- Type: double
»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
»Regex
{@link https://www.terraform.io/docs/language/functions/regex.html regex} applies a regular expression to a string and returns the matching substrings in pattern.
»Pattern
Required
- Type: string
»Value
Required
- Type: string
»Regexall
{@link https://www.terraform.io/docs/language/functions/regexall.html regexall} applies a regular expression to a string and returns a list of all matches.
»Pattern
Required
- Type: string
»Value
Required
- Type: string
»Replace
{@link https://www.terraform.io/docs/language/functions/replace.html replace} searches a given string for another given substring, and replaces each occurrence with a given replacement string.
»Value
Required
- Type: string
»Substring
Required
- Type: string
»Replacement
Required
- Type: string
»Reverse
{@link https://www.terraform.io/docs/language/functions/reverse.html 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.
»Values
Required
- Type: object
»Rsadecrypt
{@link https://www.terraform.io/docs/language/functions/rsadecrypt.html rsadecrypt} decrypts an RSA-encrypted ciphertext, returning the corresponding cleartext.
»Ciphertext
Required
- Type: string
»Privatekey
Required
- Type: string
»Sensitive
{@link https://www.terraform.io/docs/language/functions/sensitive.html 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.
»Expression
Required
- Type: object
»Setintersection
{@link https://www.terraform.io/docs/language/functions/setintersection.html setintersection} function takes multiple sets and produces a single set containing only the elements that all of the given sets have in common.
»Values
Required
- Type: object[]
»Setproduct
{@link https://www.terraform.io/docs/language/functions/setproduct.html setproduct} function finds all of the possible combinations of elements from all of the given sets by computing the Cartesian product.
»Values
Required
- Type: object[]
»Setsubtract
{@link https://www.terraform.io/docs/language/functions/slice.html setsubtract} function returns a new set containing the elements from the first set that are not present in the second set.
»Minuend
Required
- Type: object
»Subtrahend
Required
- Type: object
»Setunion
{@link https://www.terraform.io/docs/language/functions/setunion.html setunion} function takes multiple sets and produces a single set containing the elements from all of the given sets.
»Values
Required
- Type: object[]
Arguments are passed in an array.
»Sha1
{@link https://www.terraform.io/docs/language/functions/sha1.html sha1} computes the SHA1 hash of a given string and encodes it with hexadecimal digits.
»Value
Required
- Type: string
»Sha256
{@link https://www.terraform.io/docs/language/functions/sha256.html sha256} computes the SHA256 hash of a given string and encodes it with hexadecimal digits.
»Value
Required
- Type: string
»Sha512
{@link https://www.terraform.io/docs/language/functions/sha512.html sha512} computes the SHA512 hash of a given string and encodes it with hexadecimal digits.
»Value
Required
- Type: string
»Signum
{@link https://www.terraform.io/docs/language/functions/signum.html signum} determines the sign of a number, returning a number between -1 and 1 to represent the sign.
»Value
Required
- Type: double
»Slice
{@link https://www.terraform.io/docs/language/functions/slice.html slice} extracts some consecutive elements from within a list.
»List
Required
- Type: object
»Startindex
Required
- Type: double
»Endindex
Required
- Type: double
»Sort
{@link https://www.terraform.io/docs/language/functions/sort.html sort} takes a list of strings and returns a new list with those strings sorted lexicographically.
»List
Required
- Type: object
»Split
{@link https://www.terraform.io/docs/language/functions/split.html split} produces a list by dividing a given string at all occurrences of a given separator.
»Seperator
Required
- Type: string
»Value
Required
- Type: string
»Strrev
{@link https://www.terraform.io/docs/language/functions/strrev.html strrev} reverses the characters in a string.
»Value
Required
- Type: string
»Substr
{@link https://www.terraform.io/docs/language/functions/substr.html substr} extracts a substring from a given string by offset and length.
»Value
Required
- Type: string
»Offset
Required
- Type: double
»Length
Required
- Type: double
»Sum
{@link https://www.terraform.io/docs/language/functions/sum.html sum} takes a list or set of numbers and returns the sum of those numbers.
»List
Required
- Type: object
»Templatefile
{@link https://www.terraform.io/docs/language/functions/templatefile.html 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: object
»Textdecodebase64
{@link https://www.terraform.io/docs/language/functions/textdecodebase64.html textdecodebase64} function decodes a string that was previously Base64-encoded, and then interprets the result as characters in a specified character encoding.
»Value
Required
- Type: string
»EncodingName
Required
- Type: string
»Textencodebase64
{@link https://www.terraform.io/docs/language/functions/textencodebase64.html 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.
»Value
Required
- Type: string
»EncodingName
Required
- Type: string
»Timeadd
{@link https://www.terraform.io/docs/language/functions/timeadd.html timeadd} adds a duration to a timestamp, returning a new timestamp.
»Timestamp
Required
- Type: string
»Duration
Required
- Type: string
»Timestamp
{@link https://www.terraform.io/docs/language/functions/timestamp.html timestamp} returns a UTC timestamp string in RFC 3339 format.
»Title
{@link https://www.terraform.io/docs/language/functions/title.html title} converts the first letter of each word in the given string to uppercase.
»Value
Required
- Type: string
»Tobool
{@link https://www.terraform.io/docs/language/functions/tobool.html tobool} converts its argument to a boolean value.
»Expression
Required
- Type: object
»Tolist
{@link https://www.terraform.io/docs/language/functions/tolist.html tolist} converts its argument to a list value.
»Expression
Required
- Type: object
»Tomap
{@link https://www.terraform.io/docs/language/functions/tomap.html tomap} converts its argument to a map value.
»Expression
Required
- Type: object
»Tonumber
{@link https://www.terraform.io/docs/language/functions/tonumber.html tonumber} converts its argument to a number value.
»Expression
Required
- Type: object
»Toset
{@link https://www.terraform.io/docs/language/functions/toset.html toset} converts its argument to a set value.
»Expression
Required
- Type: object
»Tostring
{@link https://www.terraform.io/docs/language/functions/tostring.html tostring} converts its argument to a string value.
»Expression
Required
- Type: object
»Transpose
{@link https://www.terraform.io/docs/language/functions/transpose.html transpose} takes a map of lists of strings and swaps the keys and values to produce a new map of lists of strings.
»Value
Required
- Type: object
»Trim
{@link https://www.terraform.io/docs/language/functions/trim.html trim} removes the specified characters from the start and end of the given string.
»Value
Required
- Type: string
»Replacement
Required
- Type: string
»Trimprefix
{@link https://www.terraform.io/docs/language/functions/trimprefix.html trimprefix} removes the specified prefix from the start of the given string.
»Value
Required
- Type: string
»Prefix
Required
- Type: string
»Trimspace
{@link https://www.terraform.io/docs/language/functions/trimspace.html trimspace} removes any space characters from the start and end of the given string.
»Value
Required
- Type: string
»Trimsuffix
{@link https://www.terraform.io/docs/language/functions/trimsuffix.html trimsuffix} removes the specified suffix from the end of the given string.
»Value
Required
- Type: string
»Suffix
Required
- Type: string
»Try
{@link https://www.terraform.io/docs/language/functions/try.html try} evaluates all of its argument expressions in turn and returns the result of the first one that does not produce any errors.
»Expression
Required
- Type: object[]
»Upper
{@link https://www.terraform.io/docs/language/functions/upper.html upper} converts all cased letters in the given string to uppercase.
»Value
Required
- Type: string
»Urlencode
{@link https://www.terraform.io/docs/language/functions/urlencode.html urlencode} applies URL encoding to a given string.
»Value
Required
- Type: string
»Uuid
{@link https://www.terraform.io/docs/language/functions/uuid.html uuid} generates a unique identifier string.
»Uuidv5
{@link https://www.terraform.io/docs/language/functions/uuidv5.html uuidv5} generates a unique identifier string.
»Namespace
Required
- Type: string
»Name
Required
- Type: string
»Values
{@link https://www.terraform.io/docs/language/functions/values.html values} takes a map and returns a list containing the values of the elements in that map.
»Value
Required
- Type: object
»Yamldecode
{@link https://www.terraform.io/docs/language/functions/yamldecode.html yamldecode} parses a string as a subset of YAML, and produces a representation of its value.
»Value
Required
- Type: string
»Yamlencode
{@link https://www.terraform.io/docs/language/functions/yamlencode.html yamlencode} encodes a given value to a string using JSON syntax.
»Value
Required
- Type: object
»Zipmap
{@link https://www.terraform.io/docs/language/functions/zipmap.html zipmap} constructs a map from a list of keys and a corresponding list of values.
»Keyslist
Required
- Type: object
»Valueslist
Required
- Type: object
»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 | object | No description. |
»List
Required
- Type: object
»Methods
Name | Description |
---|---|
Dynamic | No description. |
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. |
»Dynamic
»Attributes
Required
- Type: System.Collections.Generic.IDictionary< string, object >
»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.
»Static Functions
Name | Description |
---|---|
FromList | Creates a new iterator from a list. |
FromMap | Creates a new iterator from a map. |
»FromList
Creates a new iterator from a list.
»List
Required
- Type: object
»FromMap
Creates a new iterator from a map.
»Map
Required
- Type: object
»Properties
Name | Type | Description |
---|---|---|
Key | object | Returns the currenty entry in the list or set that is being iterated over. |
Value | object | Returns the value of the current item iterated over. |
»Key
Required
- Type: object
Returns the currenty 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 using the escape hatch:
https://www.terraform.io/cdktf/concepts/resources#escape-hatch
»Value
Required
- Type: object
Returns the value of the current item iterated over.
»Manifest
- Implements: IManifest
»Initializers
Name | Type | Description |
---|---|---|
Version | string | No description. |
Outdir | string | No description. |
»Version
Required
- Type: string
»Outdir
Required
- Type: string
»Methods
Name | Description |
---|---|
BuildManifest | No description. |
ForStack | No description. |
WriteToFile | No description. |
»BuildManifest
»ForStack
»Stack
Required
- Type: TerraformStack
»WriteToFile
»Properties
Name | Type | Description |
---|---|---|
Outdir | string | No description. |
Stacks | System.Collections.Generic.IDictionary< string, StackManifest> | No description. |
Version | string | No description. |
»Outdir
Required
- Type: string
»Stacks
Required
- Type: System.Collections.Generic.IDictionary< string, StackManifest>
»Version
Required
- Type: string
»Constants
Name | Type | Description |
---|---|---|
FileName | string | No description. |
StackFileName | string | No description. |
StacksFolder | string | No description. |
»FileName
Required
- Type: string
»StackFileName
Required
- Type: string
»StacksFolder
Required
- Type: string
»MapTerraformIterator
»Initializers
Name | Type | Description |
---|---|---|
Map | object | No description. |
»Map
Required
- Type: object
»Methods
Name | Description |
---|---|
Dynamic | No description. |
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. |
»Dynamic
»Attributes
Required
- Type: System.Collections.Generic.IDictionary< string, object >
»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.
»Static Functions
Name | Description |
---|---|
FromList | Creates a new iterator from a list. |
FromMap | Creates a new iterator from a map. |
»FromList
Creates a new iterator from a list.
»List
Required
- Type: object
»FromMap
Creates a new iterator from a map.
»Map
Required
- Type: object
»Properties
Name | Type | Description |
---|---|---|
Key | string | Returns the key of the current entry in the map that is being iterated over. |
Value | object | 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: object
Returns the value of the current item iterated over.
»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 | Type | Description |
---|---|---|
Name | string | No description. |
»Name
Required
- Type: string
»Methods
Name | Description |
---|---|
ToTerraform | No description. |
»ToTerraform
»Properties
Name | Type | Description |
---|---|---|
Name | string | No description. |
»Name
Required
- 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
»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
- Implements: ITerraformAddressable, IInterpolatingParent, IResolvable
»Initializers
Name | Type | Description |
---|---|---|
TerraformResource | IInterpolatingParent | No description. |
TerraformAttribute | string | No description. |
WrapsSet | bool | No description. |
»TerraformResource
Required
- Type: IInterpolatingParent
»TerraformAttribute
Required
- Type: string
»WrapsSet
Required
- Type: bool
»Methods
Name | Description |
---|---|
ComputeFqn | No description. |
Get | No description. |
InterpolationForAttribute | No description. |
Resolve | Produce the Token's value at resolution time. |
ToString | Return a string representation of this resolvable object. |
»ComputeFqn
»Get
»Index
Required
- Type: double
»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
»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
»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: object
»Right
Required
- Type: object
»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
- Implements: ITerraformAddressable, IInterpolatingParent, IResolvable
»Initializers
Name | Type | Description |
---|---|---|
TerraformResource | IInterpolatingParent | No description. |
TerraformAttribute | string | No description. |
WrapsSet | bool | No description. |
»TerraformResource
Required
- Type: IInterpolatingParent
»TerraformAttribute
Required
- Type: string
»WrapsSet
Required
- Type: bool
»Methods
Name | Description |
---|---|
ComputeFqn | No description. |
Get | No description. |
InterpolationForAttribute | No description. |
Resolve | Produce the Token's value at resolution time. |
ToString | Return a string representation of this resolvable object. |
»ComputeFqn
»Get
»Index
Required
- Type: double
»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
»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
Name | Type | Description |
---|---|---|
Tags | string[] | No description. |
»Tags
Required
- Type: string[]
»Methods
Name | Description |
---|---|
ToTerraform | No description. |
»ToTerraform
»Properties
Name | Type | Description |
---|---|---|
Tags | string[] | No description. |
»Tags
Required
- Type: string[]
»TerraformIterator
- Implements: ITerraformIterator
»Initializers
Name | Type | Description |
---|
»Methods
Name | Description |
---|---|
Dynamic | No description. |
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. |
»Dynamic
»Attributes
Required
- Type: System.Collections.Generic.IDictionary< string, object >
»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.
»Static Functions
Name | Description |
---|---|
FromList | Creates a new iterator from a list. |
FromMap | Creates a new iterator from a map. |
»FromList
Creates a new iterator from a list.
»List
Required
- Type: object
»FromMap
Creates a new iterator from a map.
»Map
Required
- Type: object
»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. |
SynthScope | No description. |
ToBeValidTerraform | No description. |
ToHaveDataSource | No description. |
ToHaveDataSourceWithProperties | 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: TestingAppOptions
»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: bool
»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: System.Collections.Generic.IDictionary< string, object >
»ToHaveResource
»Received
Required
- Type: string
»ResourceType
Required
- Type: string
»ToHaveResourceWithProperties
»Received
Required
- Type: string
»ResourceType
Required
- Type: string
»Properties
Optional
- Type: System.Collections.Generic.IDictionary< string, object >
»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. |
»AsAny
Return a resolvable representation of the given value.
»Value
Required
- Type: object
»AsAnyMap
Return a reversible map representation of this token.
»Value
Required
- Type: object
»Options
Optional
- Type: EncodingOptions
»AsBooleanMap
Return a reversible map representation of this token.
»Value
Required
- Type: object
»Options
Optional
- Type: EncodingOptions
»AsList
Return a reversible list representation of this token.
»Value
Required
- Type: object
»Options
Optional
- Type: EncodingOptions
»AsMap
Return a reversible map representation of this token.
»Value
Required
- Type: object
»MapValue
Required
- Type: object
»Options
Optional
- Type: EncodingOptions
»AsNumber
Return a reversible number representation of this token.
»Value
Required
- Type: object
»AsNumberList
Return a reversible list representation of this token.
»Value
Required
- Type: object
»AsNumberMap
Return a reversible map representation of this token.
»Value
Required
- Type: object
»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: object
»Options
Optional
- Type: EncodingOptions
»AsStringMap
Return a reversible map representation of this token.
»Value
Required
- Type: object
»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: object
The object to test.
»Constants
Name | Type | Description |
---|---|---|
AnyMapTokenValue | string | Any map token representation. |
NumberMapTokenValue | double | Number Map token value representation. |
StringMapTokenValue | string | String Map token value representation. |
»AnyMapTokenValue
Required
- Type: string
Any map token representation.
»NumberMapTokenValue
Required
- Type: double
Number Map token value representation.
»StringMapTokenValue
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: object
»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: object
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: object
»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: System.Collections.Generic.IDictionary< string, object >
»ReverseNumber
Un-encode a Tokenized value from a number.
»N
Required
- Type: double
»ReverseNumberList
Un-encode a Tokenized value from a list.
»L
Required
- Type: double[]
»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: double
»TokenizedStringFragments
Fragments of a concatenated string containing stringified Tokens.
»Initializers
Name | Type | Description |
---|
»Methods
Name | Description |
---|---|
AddIntrinsic | Adds an intrinsic fragment. |
AddLiteral | Adds a literal fragment. |
AddToken | Adds a token fragment. |
Join | Combine the string fragments using the given joiner. |
MapTokens | Apply a transformation function to all tokens in the string. |
»AddIntrinsic
Adds an intrinsic fragment.
»Value
Required
- Type: object
the intrinsic value to add.
»AddLiteral
Adds a literal fragment.
»Lit
Required
- Type: object
the literal to add.
»AddToken
Adds a token fragment.
»Token
Required
- Type: IResolvable
the token to add.
»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.
»Mapper
Required
- Type: ITokenMapper
»Properties
Name | Type | Description |
---|---|---|
FirstValue | object | Returns the first value. |
Intrinsic | IResolvable[] | Return all intrinsic fragments from this string. |
Length | double | 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. |
»FirstValue
Required
- Type: object
Returns the first value.
»Intrinsic
Required
- Type: IResolvable[]
Return all intrinsic fragments from this string.
»Length
Required
- Type: double
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: System.Collections.Generic.IDictionary< 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. |
ListBool | string | No description. |
ListNumber | string | No description. |
ListString | string | No description. |
Map | string | No description. |
MapBool | string | No description. |
MapNumber | string | No description. |
MapString | string | No description. |
Number | string | No description. |
Set | string | No description. |
SetBool | string | No description. |
SetNumber | string | No description. |
SetString | string | No description. |
String | string | No description. |
»Any
Required
- Type: string
»Bool
Required
- Type: string
»List
Required
- Type: string
»ListBool
Required
- Type: string
»ListNumber
Required
- Type: string
»ListString
Required
- Type: string
»Map
Required
- Type: string
»MapBool
Required
- Type: string
»MapNumber
Required
- Type: string
»MapString
Required
- Type: string
»Number
Required
- Type: string
»Set
Required
- Type: string
»SetBool
Required
- Type: string
»SetNumber
Required
- Type: string
»SetString
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: 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: object
»Right
Required
- Type: object
»IInterpolatingParent
- Implemented By: AnyMapList, BooleanMapList, ComplexComputedList, ComplexObject, 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 | System.Collections.Generic.IDictionary< string, StackManifest> | No description. |
Version | string | No description. |
»Stacks
Required
- Type: System.Collections.Generic.IDictionary< 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: object
»Context
Required
- Type: IResolveContext
»IRemoteWorkspace
- Implemented By: NamedRemoteWorkspace, PrefixedRemoteWorkspaces, IRemoteWorkspace
»IResolvable
- Implemented By: AnyMap, AnyMapList, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, LazyBase, NumberMap, NumberMapList, 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: object
»Properties
Name | Type | Description |
---|---|---|
Preparing | bool | 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. |
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 | bool | True when ${} should be ommitted (because already inside them), false otherwise. |
»Preparing
Required
- Type: bool
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.
»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: bool
True when ${} should be ommitted (because already inside them), false otherwise.
»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 | bool | No description. |
»Manifest
Required
- Type: Manifest
»Outdir
Required
- Type: string
The output directory for this synthesis session.
»SkipValidation
Optional
- Type: bool
»ITerraformAddressable
- Implemented By: AnyMap, AnyMapList, BooleanMap, BooleanMapList, ComplexComputedList, ComplexList, ComplexMap, ComplexObject, DataTerraformRemoteState, DataTerraformRemoteStateArtifactory, DataTerraformRemoteStateAzurerm, DataTerraformRemoteStateConsul, DataTerraformRemoteStateCos, DataTerraformRemoteStateEtcd, DataTerraformRemoteStateEtcdV3, DataTerraformRemoteStateGcs, DataTerraformRemoteStateHttp, DataTerraformRemoteStateLocal, DataTerraformRemoteStateManta, DataTerraformRemoteStateOss, DataTerraformRemoteStatePg, DataTerraformRemoteStateS3, DataTerraformRemoteStateSwift, NumberMap, NumberMapList, 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: TerraformDataSource, TerraformHclModule, TerraformModule, TerraformResource, ITerraformDependable
»Properties
Name | Type | Description |
---|---|---|
Fqn | string | No description. |
»Fqn
Required
- Type: string
»ITerraformIterator
- Implemented By: ListTerraformIterator, MapTerraformIterator, TerraformIterator, ITerraformIterator
»ITerraformResource
- Implemented By: 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 | double | 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: double
»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: System.Collections.Generic.IDictionary< string, object >
»Context
Required
- Type: IResolveContext
»ResolveNumberList
Resolve a tokenized number list.
»L
Required
- Type: double[]
»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
»Enums
»AnnotationMetadataEntryType
»Members
Name | Description |
---|---|
INFO | No description. |
WARN | No description. |
ERROR | No description. |
»INFO
»WARN
»ERROR
»AssetType
»Members
Name | Description |
---|---|
FILE | No description. |
DIRECTORY | No description. |
ARCHIVE | No description. |