Class Variable

Hierarchy (view full)

Block<VariableArgs>
- Variable

Index

Constructors

Properties

blockNames blockType name

Accessors

Methods

asArgument attr deleteArgument getArgument getArguments getInnerBlocks isInsideTerraformBlock setArgument setArguments setInnerBlocks toTerraform

Constructors

constructor

new Variable(name, args): Variable
Construct variable.

Refer to Terraform documentation on what can be put as arguments.
Parameters
- name: string
  name
- args: VariableArgs
  arguments
Returns Variable
Overrides Block.constructor

Properties

`Readonly` blockNames

blockNames: string[]

`Readonly` blockType

blockType: string

`Readonly` name

name: string

Accessors

id

get id(): Attribute
Block's id attribute.

Returns Attribute
Inherited from Block.id

Methods

asArgument

asArgument(): Argument<string>
Represent block as argument.

Returns Argument<string>
Overrides Block.asArgument

attr

attr(name): Attribute
Get block's attribute.
Parameters
- name: string
  attribute name
Returns Attribute
Overrides Block.attr

deleteArgument

deleteArgument(key): this
Delete argument by key.
Parameters
- key: string
  key
Returns this
Inherited from Block.deleteArgument

getArgument

getArgument<K>(key): VariableArgs[K]
Get argument by key.
Type Parameters
- K extends keyof VariableArgs
Parameters
- key: K
  key
Returns VariableArgs[K]
Inherited from Block.getArgument

getArguments

getArguments(): VariableArgs
Get arguments.

Returns VariableArgs
Inherited from Block.getArguments

`Protected` getInnerBlocks

getInnerBlocks(): Block<TerraformArgs>[]
Get inner blocks.

Returns Block<TerraformArgs>[]
Inherited from Block.getInnerBlocks

isInsideTerraformBlock

isInsideTerraformBlock(): boolean
Is this block to be placed inside top-level terraform block.

Returns boolean
Inherited from Block.isInsideTerraformBlock

setArgument

setArgument<K>(key, value): this
Set argument.
Type Parameters
- K extends keyof VariableArgs
Parameters
- key: K
  key
- value: VariableArgs[K]
  value
Returns this
Inherited from Block.setArgument

setArguments

setArguments(args): this
Set arguments.
Parameters
- args: Partial<VariableArgs>
  arguments
Returns this
Inherited from Block.setArguments

`Protected` setInnerBlocks

setInnerBlocks(innerBlocks): this
Set inner blocks.
Parameters
- innerBlocks: undefined | Block<TerraformArgs>[]
Returns this
Inherited from Block.setInnerBlocks

toTerraform

toTerraform(): string
To Terraform representation.

Returns string
Inherited from Block.toTerraform