Class Block<Args>Abstract

constructor

• new Block<Args>(type, names, args, innerBlocks?, insideTerraformBlock?): Block<Args>

• Construct block.

  Type Parameters

  • Args extends TerraformArgs = TerraformArgs

  Parameters

  • type: string

    type

  • names: string[]

    names

  • args: Args

    arguments

  • Optional innerBlocks: Block<TerraformArgs>[]

  • insideTerraformBlock: boolean = false

  Returns Block<Args>

Readonly blockNames

Readonly blockType

id

• get id(): Attribute

• Block's id attribute.

  Returns Attribute

Abstract asArgument

• asArgument(): Argument<string>

• Represent block as argument.

  Returns Argument<string>

Abstract attr

• attr(name): Attribute

• Get block's attribute.

  Parameters

  • name: string

    attribute name

  Returns Attribute

deleteArgument

• deleteArgument(key): this

• Delete argument by key.

  Parameters

  • key: string

    key

  Returns this

getArgument

• getArgument<K>(key): 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

isInsideTerraformBlock

• isInsideTerraformBlock(): boolean

• Is this block to be placed inside top-level terraform block.

  Returns boolean

setArgument

• setArgument<K>(key, value): this

• Set argument.

  Type Parameters

  • K extends string | number | symbol

  Parameters

  • key: K

    key

  • value: Args[K]

    value

  Returns this

setArguments

• setArguments(args): this

• Set arguments.

  Parameters

  • args: Partial<Args>

    arguments

  Returns this

toTerraform

• toTerraform(): string

• To Terraform representation.

  Returns string