Terraform
CSharp: Constructs
App
Represents a cdktf application.
Initializers
using HashiCorp.Cdktf;
new App(AppConfig Config = null);
Config
Optional
- Type: AppConfig
configuration.
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
CrossStackReference | Creates a reference from one stack to another, invoked on prepareStack since it creates extra resources. |
Synth | Synthesizes all resources to the output directory. |
ToString
private string ToString()
Returns a string representation of this construct.
CrossStackReference
private string CrossStackReference(TerraformStack FromStack, TerraformStack ToStack, string Identifier)
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
private void 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
using HashiCorp.Cdktf;
App.IsConstruct(object X);
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
using HashiCorp.Cdktf;
App.IsApp(object X);
X
Required
- Type: object
Of
using HashiCorp.Cdktf;
App.Of(IConstruct Construct);
Construct
Required
- Type: Constructs.IConstruct
Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
HclOutput | bool | No description. |
Manifest | Manifest | No description. |
Outdir | string | The output directory into which resources will be synthesized. |
SkipBackendValidation | bool | Whether to skip backend validation during synthesis of the app. |
SkipValidation | bool | Whether to skip all validations during synthesis of the app. |
TargetStackId | string | The stack which will be synthesized. |
Node
Required
public Node Node { get; }
- Type: Constructs.Node
The tree node.
HclOutput
Required
public bool HclOutput { get; }
- Type: bool
Manifest
Required
public Manifest Manifest { get; }
- Type: Manifest
Outdir
Required
public string Outdir { get; }
- Type: string
The output directory into which resources will be synthesized.
SkipBackendValidation
Required
public bool SkipBackendValidation { get; }
- Type: bool
Whether to skip backend validation during synthesis of the app.
SkipValidation
Required
public bool SkipValidation { get; }
- Type: bool
Whether to skip all validations during synthesis of the app.
TargetStackId
Optional
public string TargetStackId { get; }
- Type: string
The stack which will be synthesized.
If not set, all stacks will be synthesized.
AzurermBackend
Initializers
using HashiCorp.Cdktf;
new AzurermBackend(Construct Scope, AzurermBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | AzurermBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: AzurermBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
AzurermBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
AzurermBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
AzurermBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
CloudBackend
The Cloud Backend synthesizes a {@link https://developer.hashicorp.com/terraform/cli/cloud/settings#the-cloud-block cloud block}. The cloud block is a nested block within the top-level terraform settings block. It specifies which Terraform Cloud workspaces to use for the current working directory. The cloud block only affects Terraform CLI's behavior. When Terraform Cloud uses a configuration that contains a cloud block - for example, when a workspace is configured to use a VCS provider directly - it ignores the block and behaves according to its own workspace settings.
Initializers
using HashiCorp.Cdktf;
new CloudBackend(Construct Scope, CloudBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | CloudBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: CloudBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
CloudBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
CloudBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
CloudBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
ConsulBackend
Initializers
using HashiCorp.Cdktf;
new ConsulBackend(Construct Scope, ConsulBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | ConsulBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: ConsulBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
ConsulBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
ConsulBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
ConsulBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
CosBackend
Initializers
using HashiCorp.Cdktf;
new CosBackend(Construct Scope, CosBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | CosBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: CosBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
CosBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
CosBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
CosBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
DataResource
The DataResource implements the standard resource lifecycle, but does not directly take any other actions.
You can use the DataResource resource without requiring or configuring a provider.
The DataResource resource is useful for storing values which need to follow a manage resource lifecycle, and for triggering provisioners when there is no other logical managed resource in which to place them.
It requires Terraform 1.4 or later.
It is also possible to generate these bindings by adding "terraform.io/builtin/terraform" to the "terraformProviders" key in your cdktf.json file and running "cdktf get".
https://developer.hashicorp.com/terraform/language/resources/terraform-data
Initializers
using HashiCorp.Cdktf;
new DataResource(Construct Scope, string Id, DataConfig Config = null);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | The scope in which to define this construct. |
Id | string | The scoped construct ID. |
Config | DataConfig | No description. |
Scope
Required
- Type: Constructs.Construct
The scope in which to define this construct.
Id
Required
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
Config
Optional
- Type: DataConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
GetAnyMapAttribute | No description. |
GetBooleanAttribute | No description. |
GetBooleanMapAttribute | No description. |
GetListAttribute | No description. |
GetNumberAttribute | No description. |
GetNumberListAttribute | No description. |
GetNumberMapAttribute | No description. |
GetStringAttribute | No description. |
GetStringMapAttribute | No description. |
HasResourceMove | No description. |
ImportFrom | No description. |
InterpolationForAttribute | No description. |
MoveFromId | Move the resource corresponding to "id" to this resource. |
MoveTo | Moves this resource to the target resource given by moveTarget. |
MoveToId | Moves this resource to the resource corresponding to "id". |
ResetInput | No description. |
ResetTriggersReplace | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
AddMoveTarget
private void AddMoveTarget(string MoveTarget)
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
MoveTarget
Required
- Type: string
The string move target that will correspond to this resource.
GetAnyMapAttribute
private System.Collections.Generic.IDictionary< string, object > GetAnyMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetBooleanMapAttribute
private System.Collections.Generic.IDictionary< string, bool > GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberMapAttribute
private System.Collections.Generic.IDictionary< string, double > GetNumberMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetStringMapAttribute
private System.Collections.Generic.IDictionary< string, string > GetStringMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
Id
Required
- Type: string
Provider
Optional
- Type: TerraformProvider
InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
MoveFromId
private void MoveFromId(string Id)
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
Id
Required
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
MoveTo
private void MoveTo(string MoveTarget, object Index = null)
Moves this resource to the target resource given by moveTarget.
MoveTarget
Required
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
Index
Optional
- Type: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
MoveToId
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
Id
Required
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
ResetInput
private void ResetInput()
ResetTriggersReplace
private void ResetTriggersReplace()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformResource | No description. |
GenerateConfigForImport | Generates CDKTF code for importing a Data resource upon running "cdktf plan < stack-name >". |
IsConstruct
using HashiCorp.Cdktf;
DataResource.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataResource.IsTerraformElement(object X);
X
Required
- Type: object
IsTerraformResource
using HashiCorp.Cdktf;
DataResource.IsTerraformResource(object X);
X
Required
- Type: object
GenerateConfigForImport
using HashiCorp.Cdktf;
DataResource.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a Data resource upon running "cdktf plan < stack-name >".
Scope
Required
- Type: Constructs.Construct
The scope in which to define this construct.
ImportToId
Required
- Type: string
The construct id used in the generated config for the Data to import.
ImportFromId
Required
- Type: string
The id of the existing Data that should be imported.
Refer to the {@link https://terraform.io/providers/builtin/terraform/latest/docs/resources/data#import import section} in the documentation of this resource for the id to use
Provider
Optional
- Type: TerraformProvider
? Optional instance of the provider where the Data to import is found.
Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
CdktfStack | TerraformStack | No description. |
Fqn | string | No description. |
FriendlyUniqueId | string | No description. |
TerraformMetaArguments | System.Collections.Generic.IDictionary< string, object > | No description. |
TerraformResourceType | string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Connection | object | No description. |
Count | object | No description. |
DependsOn | string[] | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Provisioners | object[] | No description. |
Id | string | No description. |
Output | AnyMap | No description. |
InputInput | System.Collections.Generic.IDictionary< string, object > | No description. |
TriggersReplaceInput | System.Collections.Generic.IDictionary< string, object > | No description. |
Input | System.Collections.Generic.IDictionary< string, object > | (Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply. |
TriggersReplace | System.Collections.Generic.IDictionary< string, object > | (Optional) A value which is stored in the instance state, and will force replacement when the value changes. |
Node
Required
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
TerraformMetaArguments
Required
public System.Collections.Generic.IDictionary< string, object > TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
TerraformResourceType
Required
public string TerraformResourceType { get; }
- Type: string
TerraformGeneratorMetadata
Optional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
Connection
Optional
public object Connection { get; }
- Type: object
Count
Optional
public object Count { get; }
- Type: object
DependsOn
Optional
public string[] DependsOn { get; }
- Type: string[]
ForEach
Optional
public ITerraformIterator ForEach { get; }
- Type: ITerraformIterator
Lifecycle
Optional
public TerraformResourceLifecycle Lifecycle { get; }
Provider
Optional
public TerraformProvider Provider { get; }
- Type: TerraformProvider
Provisioners
Optional
public object[] Provisioners { get; }
- Type: object[]
Id
Required
public string Id { get; }
- Type: string
Output
Required
public AnyMap Output { get; }
- Type: AnyMap
InputInput
Optional
public System.Collections.Generic.IDictionary< string, object > InputInput { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
TriggersReplaceInput
Optional
public System.Collections.Generic.IDictionary< string, object > TriggersReplaceInput { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
Input
Required
public System.Collections.Generic.IDictionary< string, object > Input { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
(Optional) A value which will be stored in the instance state, and reflected in the output attribute after apply.
https://developer.hashicorp.com/terraform/language/resources/terraform-data#input
TriggersReplace
Required
public System.Collections.Generic.IDictionary< string, object > TriggersReplace { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
(Optional) A value which is stored in the instance state, and will force replacement when the value changes.
https://developer.hashicorp.com/terraform/language/resources/terraform-data#triggers_replace
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteState
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteState(Construct Scope, string Id, DataTerraformRemoteStateRemoteConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateRemoteConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteState.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteState.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateAzurerm
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateAzurerm(Construct Scope, string Id, DataTerraformRemoteStateAzurermConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateAzurermConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateAzurerm.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateAzurerm.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateConsul
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateConsul(Construct Scope, string Id, DataTerraformRemoteStateConsulConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateConsulConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateConsul.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateConsul.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateCos
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateCos(Construct Scope, string Id, DataTerraformRemoteStateCosConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateCosConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateCos.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateCos.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateGcs
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateGcs(Construct Scope, string Id, DataTerraformRemoteStateGcsConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateGcsConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateGcs.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateGcs.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateHttp
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateHttp(Construct Scope, string Id, DataTerraformRemoteStateHttpConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateHttpConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateHttp.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateHttp.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateLocal
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateLocal(Construct Scope, string Id, DataTerraformRemoteStateLocalConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateLocalConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateLocal.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateLocal.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateOss
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateOss(Construct Scope, string Id, DataTerraformRemoteStateOssConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateOssConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateOss.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateOss.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStatePg
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStatePg(Construct Scope, string Id, DataTerraformRemoteStatePgConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStatePgConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStatePg.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStatePg.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateS3
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateS3(Construct Scope, string Id, DataTerraformRemoteStateS3Config Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateS3Config | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateS3.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateS3.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
DataTerraformRemoteStateSwift
Initializers
using HashiCorp.Cdktf;
new DataTerraformRemoteStateSwift(Construct Scope, string Id, DataTerraformRemoteStateSwiftConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | DataTerraformRemoteStateSwiftConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
ResetOverrideLogicalId
ResetOverrideLogicalId
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
ToMetadata
private object ToMetadata()
ToTerraform
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
IsConstruct
using HashiCorp.Cdktf;
DataTerraformRemoteStateSwift.IsConstruct(object X);
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.
IsTerraformElement
IsTerraformElement
using HashiCorp.Cdktf;
DataTerraformRemoteStateSwift.IsTerraformElement(object X);
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
Node
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
CdktfStack
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
Fqn
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
FriendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
TfResourceType
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public string TfResourceType { get; }
- Type: string
GcsBackend
Initializers
using HashiCorp.Cdktf;
new GcsBackend(Construct Scope, GcsBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | GcsBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: GcsBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
GcsBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
GcsBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
GcsBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
HttpBackend
Initializers
using HashiCorp.Cdktf;
new HttpBackend(Construct Scope, HttpBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | HttpBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: HttpBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
HttpBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
HttpBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
HttpBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
ImportableResource
Class used to represent an importable resource.
Initializers
using HashiCorp.Cdktf;
new ImportableResource(Construct Scope, string Name, IImportableConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Name | string | No description. |
Config | IImportableConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
Config
Required
- Type: IImportableConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
ImportableResource.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
ImportableResource.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
LocalBackend
Initializers
using HashiCorp.Cdktf;
new LocalBackend(Construct Scope, LocalBackendConfig Props = null);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | LocalBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Optional
- Type: LocalBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
LocalBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
LocalBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
LocalBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
OssBackend
Initializers
using HashiCorp.Cdktf;
new OssBackend(Construct Scope, OssBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | OssBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: OssBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
OssBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
OssBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
OssBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
PgBackend
Initializers
using HashiCorp.Cdktf;
new PgBackend(Construct Scope, PgBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | PgBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: PgBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
PgBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
PgBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
PgBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
RemoteBackend
Initializers
using HashiCorp.Cdktf;
new RemoteBackend(Construct Scope, RemoteBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | RemoteBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: RemoteBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
RemoteBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
RemoteBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
RemoteBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Resource
- Implements: IResource
A construct which represents a resource.
Initializers
using HashiCorp.Cdktf;
new Resource(Construct Scope, string Id);
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
ToString
ToString
private string ToString()
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsConstruct
IsConstruct
using HashiCorp.Cdktf;
Resource.IsConstruct(object X);
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.
public Node Node { get; }
- Type: Constructs.Node
The tree node.
Stack
Required
Stack
- Deprecated: - Please use Construct from the constructs package instead.
public TerraformStack Stack { get; }
- Type: TerraformStack
The stack in which this resource is defined.
S3Backend
Initializers
using HashiCorp.Cdktf;
new S3Backend(Construct Scope, S3BackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | S3BackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: S3BackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
S3Backend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
S3Backend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
S3Backend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
SwiftBackend
Initializers
using HashiCorp.Cdktf;
new SwiftBackend(Construct Scope, SwiftBackendConfig Props);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Props | SwiftBackendConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Props
Required
- Type: SwiftBackendConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
NewLogicalId
Required
- Type: string
The new logical ID to use for this stack element.
ResetOverrideLogicalId
ResetOverrideLogicalId
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
ToHclTerraform
private object ToHclTerraform()
ToMetadata
ToMetadata
private object ToMetadata()
ToTerraform
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
IsConstruct
using HashiCorp.Cdktf;
SwiftBackend.IsConstruct(object X);
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.
IsTerraformElement
IsTerraformElement
using HashiCorp.Cdktf;
SwiftBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
IsBackend
using HashiCorp.Cdktf;
SwiftBackend.IsBackend(object X);
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
Node
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
CdktfStack
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
Fqn
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
FriendlyUniqueId
- Deprecated: CDK for Terraform no longer supports the swift backend. Terraform deprecated swift in v1.2.3 and removed it in v1.3.
public string FriendlyUniqueId { get; }
- Type: string
TerraformAsset
Initializers
using HashiCorp.Cdktf;
new TerraformAsset(Construct Scope, string Id, TerraformAssetConfig Config);
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
private string ToString()
Returns a string representation of this construct.
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsConstruct
using HashiCorp.Cdktf;
TerraformAsset.IsConstruct(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
FileName
Required
public string FileName { get; }
- Type: string
Name of the asset.
Path
Required
public string Path { get; }
- Type: string
The path relative to the root of the terraform directory in posix format Use this property to reference the asset.
AssetHash
Required
public string AssetHash { get; }
- Type: string
Type
Required
public AssetType Type { get; }
- Type: AssetType
TerraformBackend
Initializers
using HashiCorp.Cdktf;
new TerraformBackend(Construct Scope, string Id, string Name);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Name | string | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Name
Required
- Type: string
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetRemoteStateDataSource | Creates a TerraformRemoteState resource that accesses this backend. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetRemoteStateDataSource
private TerraformRemoteState GetRemoteStateDataSource(Construct Scope, string Name, string FromStack)
Creates a TerraformRemoteState resource that accesses this backend.
Scope
Required
- Type: Constructs.Construct
Name
Required
- Type: string
FromStack
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsBackend | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformBackend.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformBackend.IsTerraformElement(object X);
X
Required
- Type: object
IsBackend
using HashiCorp.Cdktf;
TerraformBackend.IsBackend(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
TerraformDataSource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
using HashiCorp.Cdktf;
new TerraformDataSource(Construct Scope, string Id, TerraformResourceConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | TerraformResourceConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
- Type: TerraformResourceConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
GetAnyMapAttribute | No description. |
GetBooleanAttribute | No description. |
GetBooleanMapAttribute | No description. |
GetListAttribute | No description. |
GetNumberAttribute | No description. |
GetNumberListAttribute | No description. |
GetNumberMapAttribute | No description. |
GetStringAttribute | No description. |
GetStringMapAttribute | No description. |
InterpolationForAttribute | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
GetAnyMapAttribute
private System.Collections.Generic.IDictionary< string, object > GetAnyMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetBooleanMapAttribute
private System.Collections.Generic.IDictionary< string, bool > GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberMapAttribute
private System.Collections.Generic.IDictionary< string, double > GetNumberMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetStringMapAttribute
private System.Collections.Generic.IDictionary< string, string > GetStringMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformDataSource | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformDataSource.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformDataSource.IsTerraformElement(object X);
X
Required
- Type: object
IsTerraformDataSource
using HashiCorp.Cdktf;
TerraformDataSource.IsTerraformDataSource(object X);
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. |
TerraformMetaArguments | System.Collections.Generic.IDictionary< string, object > | No description. |
TerraformResourceType | string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Count | object | No description. |
DependsOn | string[] | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Node
Required
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
TerraformMetaArguments
Required
public System.Collections.Generic.IDictionary< string, object > TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
TerraformResourceType
Required
public string TerraformResourceType { get; }
- Type: string
TerraformGeneratorMetadata
Optional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
Count
Optional
public object Count { get; }
- Type: object
DependsOn
Optional
public string[] DependsOn { get; }
- Type: string[]
ForEach
Optional
public ITerraformIterator ForEach { get; }
- Type: ITerraformIterator
Lifecycle
Optional
public TerraformResourceLifecycle Lifecycle { get; }
Provider
Optional
public TerraformProvider Provider { get; }
- Type: TerraformProvider
TerraformElement
Initializers
using HashiCorp.Cdktf;
new TerraformElement(Construct Scope, string Id, string ElementType = null);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
ElementType | string | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
ElementType
Optional
- Type: string
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformElement.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformElement.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
TerraformHclModule
Initializers
using HashiCorp.Cdktf;
new TerraformHclModule(Construct Scope, string Id, TerraformHclModuleConfig Options);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Options | TerraformHclModuleConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Options
Required
- Type: TerraformHclModuleConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | No description. |
AddProvider | No description. |
GetString | No description. |
InterpolationForOutput | No description. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
Set | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
AddProvider
private void AddProvider(object Provider)
Provider
Required
- Type: object
GetString
private string GetString(string Output)
Output
Required
- Type: string
InterpolationForOutput
private IResolvable InterpolationForOutput(string ModuleOutput)
ModuleOutput
Required
- Type: string
Get
private object Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
Set
private void Set(string Variable, object Value)
Variable
Required
- Type: string
Value
Required
- Type: object
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformHclModule.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformHclModule.IsTerraformElement(object X);
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. |
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Source
Required
public string Source { get; }
- Type: string
Providers
Optional
public object[] Providers { get; }
- Type: object[]
SkipAssetCreationFromLocalModules
Optional
public bool SkipAssetCreationFromLocalModules { get; }
- Type: bool
Version
Optional
public string Version { get; }
- Type: string
DependsOn
Optional
public string[] DependsOn { get; }
- Type: string[]
ForEach
Optional
public ITerraformIterator ForEach { get; }
- Type: ITerraformIterator
Variables
Optional
public System.Collections.Generic.IDictionary< string, object > Variables { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
TerraformLocal
- Implements: ITerraformAddressable
Initializers
using HashiCorp.Cdktf;
new TerraformLocal(Construct Scope, string Id, object Expression);
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. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformLocal.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformLocal.IsTerraformElement(object X);
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. |
AsAnyMap | System.Collections.Generic.IDictionary< string, object > | No description. |
AsBoolean | IResolvable | No description. |
AsBooleanMap | System.Collections.Generic.IDictionary< string, bool > | No description. |
AsList | string[] | No description. |
AsNumber | double | No description. |
AsNumberMap | System.Collections.Generic.IDictionary< string, double > | No description. |
AsString | string | No description. |
AsStringMap | System.Collections.Generic.IDictionary< string, string > | No description. |
Expression | object | No description. |
Node
Required
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
AsAnyMap
Required
public System.Collections.Generic.IDictionary< string, object > AsAnyMap { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
AsBoolean
Required
public IResolvable AsBoolean { get; }
- Type: IResolvable
AsBooleanMap
Required
public System.Collections.Generic.IDictionary< string, bool > AsBooleanMap { get; }
- Type: System.Collections.Generic.IDictionary< string, bool >
AsList
Required
public string[] AsList { get; }
- Type: string[]
AsNumber
Required
public double AsNumber { get; }
- Type: double
AsNumberMap
Required
public System.Collections.Generic.IDictionary< string, double > AsNumberMap { get; }
- Type: System.Collections.Generic.IDictionary< string, double >
AsString
Required
public string AsString { get; }
- Type: string
AsStringMap
Required
public System.Collections.Generic.IDictionary< string, string > AsStringMap { get; }
- Type: System.Collections.Generic.IDictionary< string, string >
Expression
Required
public object Expression { get; }
- Type: object
TerraformModule
- Implements: ITerraformDependable
TerraformModule can be used to reference a local terraform module or a module from the Terraform Registry.
It should be used if you can not use generated bindings for the module as you would get by adding the module to your cdktf.json files "terraformModules" array and running cdktf get.
This class is not creating a Terraform module to be used outside of CDKTF. If you want to bundle certain resources together like you would do with a Terraform module, you should use Constructs instead, see http://cdk.tf/constructs for more details.
Initializers
using HashiCorp.Cdktf;
new TerraformModule(Construct Scope, string Id, TerraformModuleConfig Options);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Options | TerraformModuleConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Options
Required
- Type: TerraformModuleConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | No description. |
AddProvider | No description. |
GetString | No description. |
InterpolationForOutput | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
AddProvider
private void AddProvider(object Provider)
Provider
Required
- Type: object
GetString
private string GetString(string Output)
Output
Required
- Type: string
InterpolationForOutput
private IResolvable InterpolationForOutput(string ModuleOutput)
ModuleOutput
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformModule.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformModule.IsTerraformElement(object X);
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. |
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Source
Required
public string Source { get; }
- Type: string
Providers
Optional
public object[] Providers { get; }
- Type: object[]
SkipAssetCreationFromLocalModules
Optional
public bool SkipAssetCreationFromLocalModules { get; }
- Type: bool
Version
Optional
public string Version { get; }
- Type: string
DependsOn
Optional
public string[] DependsOn { get; }
- Type: string[]
ForEach
Optional
public ITerraformIterator ForEach { get; }
- Type: ITerraformIterator
TerraformOutput
Initializers
using HashiCorp.Cdktf;
new TerraformOutput(Construct Scope, string Id, TerraformOutputConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | TerraformOutputConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
- Type: TerraformOutputConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformOutput | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformOutput.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformOutput.IsTerraformElement(object X);
X
Required
- Type: object
IsTerraformOutput
using HashiCorp.Cdktf;
TerraformOutput.IsTerraformOutput(object X);
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. |
Precondition | Precondition | No description. |
Sensitive | bool | No description. |
Node
Required
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
StaticId
Required
public bool StaticId { get; }
- Type: bool
Value
Required
public object Value { get; }
- Type: object
DependsOn
Optional
public ITerraformDependable[] DependsOn { get; }
- Type: ITerraformDependable[]
Description
Optional
public string Description { get; }
- Type: string
Precondition
Optional
public Precondition Precondition { get; }
- Type: Precondition
Sensitive
Optional
public bool Sensitive { get; }
- Type: bool
TerraformProvider
Initializers
using HashiCorp.Cdktf;
new TerraformProvider(Construct Scope, string Id, TerraformProviderConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | TerraformProviderConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
- Type: TerraformProviderConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformProvider | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformProvider.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformProvider.IsTerraformElement(object X);
X
Required
- Type: object
IsTerraformProvider
using HashiCorp.Cdktf;
TerraformProvider.IsTerraformProvider(object X);
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. |
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
MetaAttributes
Required
public System.Collections.Generic.IDictionary< string, object > MetaAttributes { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
TerraformResourceType
Required
public string TerraformResourceType { get; }
- Type: string
TerraformGeneratorMetadata
Optional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
TerraformProviderSource
Optional
public string TerraformProviderSource { get; }
- Type: string
Alias
Optional
public string Alias { get; }
- Type: string
TerraformRemoteState
- Implements: ITerraformAddressable
Initializers
using HashiCorp.Cdktf;
new TerraformRemoteState(Construct Scope, string Id, string Backend, DataTerraformRemoteStateConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Backend | string | No description. |
Config | DataTerraformRemoteStateConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Backend
Required
- Type: string
Config
Required
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | Adds this resource to the terraform JSON output. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
Get | No description. |
GetBoolean | No description. |
GetList | No description. |
GetNumber | No description. |
GetString | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
Adds this resource to the terraform JSON output.
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
Get
private IResolvable Get(string Output)
Output
Required
- Type: string
GetBoolean
private IResolvable GetBoolean(string Output)
Output
Required
- Type: string
GetList
private string[] GetList(string Output)
Output
Required
- Type: string
GetNumber
private double GetNumber(string Output)
Output
Required
- Type: string
GetString
private string GetString(string Output)
Output
Required
- Type: string
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformRemoteState.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformRemoteState.IsTerraformElement(object X);
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
Constants
Name | Type | Description |
---|---|---|
TfResourceType | string | No description. |
TfResourceType
Required
public string TfResourceType { get; }
- Type: string
TerraformResource
- Implements: ITerraformResource, ITerraformDependable, IInterpolatingParent
Initializers
using HashiCorp.Cdktf;
new TerraformResource(Construct Scope, string Id, TerraformResourceConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | TerraformResourceConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
- Type: TerraformResourceConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | Adds this resource to the terraform JSON output. |
AddMoveTarget | Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
GetAnyMapAttribute | No description. |
GetBooleanAttribute | No description. |
GetBooleanMapAttribute | No description. |
GetListAttribute | No description. |
GetNumberAttribute | No description. |
GetNumberListAttribute | No description. |
GetNumberMapAttribute | No description. |
GetStringAttribute | No description. |
GetStringMapAttribute | No description. |
HasResourceMove | No description. |
ImportFrom | No description. |
InterpolationForAttribute | No description. |
MoveFromId | Move the resource corresponding to "id" to this resource. |
MoveTo | Moves this resource to the target resource given by moveTarget. |
MoveToId | Moves this resource to the resource corresponding to "id". |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
Adds this resource to the terraform JSON output.
AddMoveTarget
private void AddMoveTarget(string MoveTarget)
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
MoveTarget
Required
- Type: string
The string move target that will correspond to this resource.
GetAnyMapAttribute
private System.Collections.Generic.IDictionary< string, object > GetAnyMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetBooleanAttribute
private IResolvable GetBooleanAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetBooleanMapAttribute
private System.Collections.Generic.IDictionary< string, bool > GetBooleanMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetListAttribute
private string[] GetListAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberAttribute
private double GetNumberAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberListAttribute
private double[] GetNumberListAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetNumberMapAttribute
private System.Collections.Generic.IDictionary< string, double > GetNumberMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetStringAttribute
private string GetStringAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
GetStringMapAttribute
private System.Collections.Generic.IDictionary< string, string > GetStringMapAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
HasResourceMove
private object HasResourceMove()
ImportFrom
private void ImportFrom(string Id, TerraformProvider Provider = null)
Id
Required
- Type: string
Provider
Optional
- Type: TerraformProvider
InterpolationForAttribute
private IResolvable InterpolationForAttribute(string TerraformAttribute)
TerraformAttribute
Required
- Type: string
MoveFromId
private void MoveFromId(string Id)
Move the resource corresponding to "id" to this resource.
Note that the resource being moved from must be marked as moved using it's instance function.
Id
Required
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
MoveTo
private void MoveTo(string MoveTarget, object Index = null)
Moves this resource to the target resource given by moveTarget.
MoveTarget
Required
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
Index
Optional
- Type: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
MoveToId
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
Id
Required
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsTerraformResource | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformResource.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformResource.IsTerraformElement(object X);
X
Required
- Type: object
IsTerraformResource
using HashiCorp.Cdktf;
TerraformResource.IsTerraformResource(object X);
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. |
TerraformMetaArguments | System.Collections.Generic.IDictionary< string, object > | No description. |
TerraformResourceType | string | No description. |
TerraformGeneratorMetadata | TerraformProviderGeneratorMetadata | No description. |
Connection | object | No description. |
Count | object | No description. |
DependsOn | string[] | No description. |
ForEach | ITerraformIterator | No description. |
Lifecycle | TerraformResourceLifecycle | No description. |
Provider | TerraformProvider | No description. |
Provisioners | object[] | No description. |
Node
Required
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
TerraformMetaArguments
Required
public System.Collections.Generic.IDictionary< string, object > TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary< string, object >
TerraformResourceType
Required
public string TerraformResourceType { get; }
- Type: string
TerraformGeneratorMetadata
Optional
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
Connection
Optional
public object Connection { get; }
- Type: object
Count
Optional
public object Count { get; }
- Type: object
DependsOn
Optional
public string[] DependsOn { get; }
- Type: string[]
ForEach
Optional
public ITerraformIterator ForEach { get; }
- Type: ITerraformIterator
Lifecycle
Optional
public TerraformResourceLifecycle Lifecycle { get; }
Provider
Optional
public TerraformProvider Provider { get; }
- Type: TerraformProvider
Provisioners
Optional
public object[] Provisioners { get; }
- Type: object[]
TerraformStack
Initializers
using HashiCorp.Cdktf;
new TerraformStack(Construct Scope, string Id);
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddDependency | No description. |
AddOverride | No description. |
AllProviders | No description. |
DependsOn | No description. |
EnsureBackendExists | No description. |
GetLogicalId | No description. |
HasResourceMove | No description. |
PrepareStack | No description. |
RegisterIncomingCrossStackReference | No description. |
RegisterOutgoingCrossStackReference | No description. |
RunAllValidations | Run all validations on the stack. |
ToHclTerraform | No description. |
ToTerraform | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddDependency
private void AddDependency(TerraformStack Dependency)
Dependency
Required
- Type: TerraformStack
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
AllProviders
private TerraformProvider[] AllProviders()
DependsOn
private bool DependsOn(TerraformStack Stack)
Stack
Required
- Type: TerraformStack
EnsureBackendExists
private TerraformBackend EnsureBackendExists()
GetLogicalId
private string GetLogicalId(object TfElement)
TfElement
Required
- Type: object
HasResourceMove
private bool HasResourceMove()
PrepareStack
private void PrepareStack()
RegisterIncomingCrossStackReference
private TerraformRemoteState RegisterIncomingCrossStackReference(TerraformStack FromStack)
FromStack
Required
- Type: TerraformStack
RegisterOutgoingCrossStackReference
private TerraformOutput RegisterOutgoingCrossStackReference(string Identifier)
Identifier
Required
- Type: string
RunAllValidations
private void RunAllValidations()
Run all validations on the stack.
ToHclTerraform
private System.Collections.Generic.IDictionary< string, object > ToHclTerraform()
ToTerraform
private object ToTerraform()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsStack | No description. |
Of | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformStack.IsConstruct(object X);
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
using HashiCorp.Cdktf;
TerraformStack.IsStack(object X);
X
Required
- Type: object
Of
using HashiCorp.Cdktf;
TerraformStack.Of(IConstruct Construct);
Construct
Required
- Type: Constructs.IConstruct
Properties
Name | Type | Description |
---|---|---|
Node | Constructs.Node | The tree node. |
Dependencies | TerraformStack[] | No description. |
MoveTargets | TerraformResourceTargets | No description. |
Synthesizer | IStackSynthesizer | No description. |
Node
Required
public Node Node { get; }
- Type: Constructs.Node
The tree node.
Dependencies
Required
public TerraformStack[] Dependencies { get; }
- Type: TerraformStack[]
MoveTargets
Required
public TerraformResourceTargets MoveTargets { get; }
- Type: TerraformResourceTargets
Synthesizer
Required
public IStackSynthesizer Synthesizer { get; }
- Type: IStackSynthesizer
TerraformVariable
- Implements: ITerraformAddressable
Initializers
using HashiCorp.Cdktf;
new TerraformVariable(Construct Scope, string Id, TerraformVariableConfig Config);
Name | Type | Description |
---|---|---|
Scope | Constructs.Construct | No description. |
Id | string | No description. |
Config | TerraformVariableConfig | No description. |
Scope
Required
- Type: Constructs.Construct
Id
Required
- Type: string
Config
Required
- Type: TerraformVariableConfig
Methods
Name | Description |
---|---|
ToString | Returns a string representation of this construct. |
AddOverride | No description. |
OverrideLogicalId | Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId | Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform | No description. |
ToMetadata | No description. |
ToTerraform | No description. |
AddValidation | No description. |
SynthesizeAttributes | No description. |
SynthesizeHclAttributes | No description. |
ToString
private string ToString()
Returns a string representation of this construct.
AddOverride
private void AddOverride(string Path, object Value)
Path
Required
- Type: string
Value
Required
- Type: object
OverrideLogicalId
private void OverrideLogicalId(string NewLogicalId)
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
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraform
private object ToHclTerraform()
ToMetadata
private object ToMetadata()
ToTerraform
private object ToTerraform()
AddValidation
private void AddValidation(TerraformVariableValidationConfig Validation)
Validation
Required
SynthesizeAttributes
private System.Collections.Generic.IDictionary< string, object > SynthesizeAttributes()
SynthesizeHclAttributes
private System.Collections.Generic.IDictionary< string, object > SynthesizeHclAttributes()
Static Functions
Name | Description |
---|---|
IsConstruct | Checks if x is a construct. |
IsTerraformElement | No description. |
IsConstruct
using HashiCorp.Cdktf;
TerraformVariable.IsConstruct(object X);
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.
IsTerraformElement
using HashiCorp.Cdktf;
TerraformVariable.IsTerraformElement(object X);
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. |
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
public Node Node { get; }
- Type: Constructs.Node
The tree node.
CdktfStack
Required
public TerraformStack CdktfStack { get; }
- Type: TerraformStack
Fqn
Required
public string Fqn { get; }
- Type: string
FriendlyUniqueId
Required
public string FriendlyUniqueId { get; }
- Type: string
BooleanValue
Required
public IResolvable BooleanValue { get; }
- Type: IResolvable
ListValue
Required
public string[] ListValue { get; }
- Type: string[]
NumberValue
Required
public double NumberValue { get; }
- Type: double
StringValue
Required
public string StringValue { get; }
- Type: string
Value
Required
public object Value { get; }
- Type: object
Default
Optional
public object Default { get; }
- Type: object
Description
Optional
public string Description { get; }
- Type: string
Nullable
Optional
public bool Nullable { get; }
- Type: bool
Sensitive
Optional
public bool Sensitive { get; }
- Type: bool
Type
Optional
public string Type { get; }
- Type: string
Validation
Optional
public TerraformVariableValidationConfig[] Validation { get; }