Class Block<Args>`Abstract`

Type Parameters

Args extends TerraformArgs = TerraformArgs

Hierarchy (View Summary)

TerraformElement
- Block

Index

Constructors

Properties

blockNames blockType

Accessors

Methods

asArgument attr deleteArgument getArgument getArguments getInnerBlocks isInsideTerraformBlock setArgument setArguments setInnerBlocks toTerraform

Constructors

constructor

new Block<Args extends TerraformArgs = TerraformArgs>(
    type: string,
    names: string[],
    args: Args,
    innerBlocks?: Block<TerraformArgs>[],
    insideTerraformBlock?: boolean,
): Block<Args>
Construct block.
Type Parameters
- Args extends TerraformArgs = TerraformArgs
Parameters
- type: string
  type
- names: string[]
  names
- args: Args
  arguments
- OptionalinnerBlocks: Block<TerraformArgs>[]
- insideTerraformBlock: boolean = false
Returns Block<Args>
Overrides TerraformElement.constructor

Properties

`Readonly`blockNames

blockNames: string[]

`Readonly`blockType

blockType: string

Accessors

id

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

Returns Attribute

Methods

`Abstract`asArgument

asArgument(): Argument
Represent block as argument.

Returns Argument

`Abstract`attr

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

deleteArgument

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

getArgument

getArgument<K extends string | number | symbol>(key: K): Args[K]
Get argument by key.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  key
Returns Args[K]

getArguments

getArguments(): Args
Get arguments.

Returns Args

`Protected`getInnerBlocks

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

Returns Block<TerraformArgs>[]

isInsideTerraformBlock

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

Returns boolean

setArgument

setArgument<K extends string | number | symbol>(key: K, value: Args[K]): this
Set argument.
Type Parameters
- K extends string | number | symbol
Parameters
- key: K
  key
- value: Args[K]
  value
Returns this

setArguments

setArguments(args: Partial<Args>): this
Set arguments.
Parameters
- args: Partial<Args>
  arguments
Returns this

`Protected`setInnerBlocks

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

toTerraform

toTerraform(): string
To Terraform representation.

Returns string
Overrides TerraformElement.toTerraform