Skip to main content

Initializers

using Io.Cdktn;

new TerraformVariable(Construct Scope, string Id, TerraformVariableConfig Config);
NameTypeDescription
ScopeConstructs.ConstructNo description.
IdstringNo description.
ConfigTerraformVariableConfigNo description.

ScopeRequired

  • Type: Constructs.Construct

IdRequired

  • Type: string

ConfigRequired


Methods

NameDescription
ToStringReturns a string representation of this construct.
AddOverrideNo description.
OverrideLogicalIdOverrides the auto-generated logical ID with a specific ID.
ResetOverrideLogicalIdResets a previously passed logical Id to use the auto-generated logical id again.
ToHclTerraformNo description.
ToMetadataNo description.
ToTerraformNo description.
AddValidationNo description.
SynthesizeAttributesNo description.
SynthesizeHclAttributesNo description.

ToString

private string ToString()
Returns a string representation of this construct.

AddOverride

private void AddOverride(string Path, object Value)

PathRequired

  • Type: string

ValueRequired

  • Type: object

OverrideLogicalId

private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.

NewLogicalIdRequired

  • 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)

ValidationRequired


SynthesizeAttributes

private System.Collections.Generic.IDictionary<string, object> SynthesizeAttributes()

SynthesizeHclAttributes

private System.Collections.Generic.IDictionary<string, object> SynthesizeHclAttributes()

Static Functions

NameDescription
IsConstructChecks if x is a construct.
IsTerraformElementNo description.

IsConstruct

using Io.Cdktn;

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.

XRequired

  • Type: object
Any object.

IsTerraformElement

using Io.Cdktn;

TerraformVariable.IsTerraformElement(object X);

XRequired

  • Type: object

Properties

NameTypeDescription
NodeConstructs.NodeThe tree node.
CdktfStackTerraformStackNo description.
FqnstringNo description.
FriendlyUniqueIdstringNo description.
BooleanValueIResolvableNo description.
ListValuestring[]No description.
NumberValuedoubleNo description.
StringValuestringNo description.
ValueobjectNo description.
DefaultobjectNo description.
DescriptionstringNo description.
NullableboolNo description.
SensitiveboolNo description.
TypestringNo description.
ValidationTerraformVariableValidationConfig[]No description.

NodeRequired

public Node Node { get; }
  • Type: Constructs.Node
The tree node.

CdktfStackRequired

public TerraformStack CdktfStack { get; }

FqnRequired

public string Fqn { get; }
  • Type: string

FriendlyUniqueIdRequired

public string FriendlyUniqueId { get; }
  • Type: string

BooleanValueRequired

public IResolvable BooleanValue { get; }

ListValueRequired

public string[] ListValue { get; }
  • Type: string[]

NumberValueRequired

public double NumberValue { get; }
  • Type: double

StringValueRequired

public string StringValue { get; }
  • Type: string

ValueRequired

public object Value { get; }
  • Type: object

DefaultOptional

public object Default { get; }
  • Type: object

DescriptionOptional

public string Description { get; }
  • Type: string

NullableOptional

public bool Nullable { get; }
  • Type: bool

SensitiveOptional

public bool Sensitive { get; }
  • Type: bool

TypeOptional

public string Type { get; }
  • Type: string

ValidationOptional

public TerraformVariableValidationConfig[] Validation { get; }