TerraformHcl

Terraform syntax helpers layered on the generic HCL DSL.

FunctionDescription
backend nameCreates a backend block inside a terraform block (e.g. backend "s3" { ... }).
check nameCreates a Terraform check block.
cloudCreates a cloud block inside a terraform block.
condition_ valueCreates a condition attribute (used in validation, precondition, etc.).
connectionCreates a connection block inside a resource or provisioner.
count valueCreates a count meta-argument.
create_before_destroy valuecreate_before_destroy = true/false inside a lifecycle block.
data sourceName nameCreates a Terraform data block.
default_ valueCreates a default attribute for a variable block.
depends_on refsCreates a depends_on meta-argument from a list of references.
description valueCreates a description string attribute.
dynamicWithIterator name forEach iteratorCreates a Terraform dynamic block with a custom iterator name.
dynamic_ name forEachCreates a Terraform dynamic block. The computation-expression
body becomes the inner content block automatically.
error_message valueCreates an error_message string attribute.
for_each valueCreates a for_each meta-argument.
from_ valueCreates a Terraform from expression attribute, used by moved and removed.
id valueCreates a Terraform import id attribute.
ignore_changes refsignore_changes = [ref, ...] inside a lifecycle block.
ignore_changes_allignore_changes = all inside a lifecycle block.
import_Creates a Terraform import block.
lifecycleCreates a lifecycle block.
localsCreates a Terraform locals block.
module_ nameCreates a Terraform module block.
move_Alias for moved_, useful when callers use the shorter term "move".
moved_Creates a Terraform moved block.
nullable valueCreates a nullable boolean attribute.
output nameCreates a Terraform output block.
postconditionCreates a postcondition block (used in lifecycle).
preconditionCreates a precondition block (used in lifecycle, output, etc.).
prevent_destroy valueprevent_destroy = true/false inside a lifecycle block.
provider nameCreates a Terraform provider block.
provider_ refCreates a provider meta-argument reference (e.g. provider = aws.west).
provisioner typeNameCreates a provisioner block (e.g. provisioner "local-exec" { ... }).
removed_Creates a Terraform removed block.
replace_triggered_by refsreplace_triggered_by = [ref, ...] inside a lifecycle block.
required_providersCreates a required_providers block inside a terraform block.
required_version valueCreates a required_version attribute inside a terraform block.
resource typeName nameCreates a Terraform resource block.
sensitive valueCreates a sensitive boolean attribute.
terraformCreates a Terraform terraform block.
to_ valueCreates a Terraform to expression attribute, used by import and moved.
type_ valueCreates a type attribute (e.g. type = string). Pass the HCL
type expression as a raw string.
validationCreates a validation block inside a variable block.
value_ valueCreates a value attribute for an output block.
variable nameCreates a Terraform variable block.

backend

backend name

Creates a backend block inside a terraform block (e.g. backend "s3" { ... }).

Parameters

  • name : string

Returns ContainerBuilder


check

check name

Creates a Terraform check block.

Parameters

  • name : string

Returns ContainerBuilder


cloud

cloud

Creates a cloud block inside a terraform block.

Returns ContainerBuilder


condition_

condition_ value

Creates a condition attribute (used in validation, precondition, etc.).

Parameters

  • value : string

Returns Node


connection

connection

Creates a connection block inside a resource or provisioner.

Returns ContainerBuilder


count

count value

Creates a count meta-argument.

Parameters

  • value : Value

Returns Node


create_before_destroy

create_before_destroy value

create_before_destroy = true/false inside a lifecycle block.

Parameters

  • value : bool

Returns Node


data

data sourceName name

Creates a Terraform data block.

Parameters

  • sourceName : string
  • name : string

Returns ContainerBuilder


default_

default_ value

Creates a default attribute for a variable block.

Parameters

  • value : Value

Returns Node


depends_on

depends_on refs

Creates a depends_on meta-argument from a list of references.

Parameters

  • refs : string list

Returns Node


description

description value

Creates a description string attribute.

Parameters

  • value : string

Returns Node


dynamicWithIterator

dynamicWithIterator name forEach iterator

Creates a Terraform dynamic block with a custom iterator name.

Parameters

  • name : string
  • forEach : string
  • iterator : string

Returns ContainerBuilder


dynamic_

dynamic_ name forEach

Creates a Terraform dynamic block. The computation-expression body becomes the inner content block automatically.

Parameters

  • name : string
  • forEach : string

Returns ContainerBuilder


error_message

error_message value

Creates an error_message string attribute.

Parameters

  • value : string

Returns Node


for_each

for_each value

Creates a for_each meta-argument.

Parameters

  • value : Value

Returns Node


from_

from_ value

Creates a Terraform from expression attribute, used by moved and removed.

Parameters

  • value : string

Returns Node


id

id value

Creates a Terraform import id attribute.

Parameters

  • value : string

Returns Node


ignore_changes

ignore_changes refs

ignore_changes = [ref, ...] inside a lifecycle block.

Parameters

  • refs : string list

Returns Node


ignore_changes_all

ignore_changes_all

ignore_changes = all inside a lifecycle block.

Returns Node


import_

import_

Creates a Terraform import block.

Returns ContainerBuilder


lifecycle

lifecycle

Creates a lifecycle block.

Returns ContainerBuilder


locals

locals

Creates a Terraform locals block.

Returns ContainerBuilder


module_

module_ name

Creates a Terraform module block.

Parameters

  • name : string

Returns ContainerBuilder


move_

move_

Alias for moved_, useful when callers use the shorter term "move".

Returns ContainerBuilder


moved_

moved_

Creates a Terraform moved block.

Returns ContainerBuilder


nullable

nullable value

Creates a nullable boolean attribute.

Parameters

  • value : bool

Returns Node


output

output name

Creates a Terraform output block.

Parameters

  • name : string

Returns ContainerBuilder


postcondition

postcondition

Creates a postcondition block (used in lifecycle).

Returns ContainerBuilder


precondition

precondition

Creates a precondition block (used in lifecycle, output, etc.).

Returns ContainerBuilder


prevent_destroy

prevent_destroy value

prevent_destroy = true/false inside a lifecycle block.

Parameters

  • value : bool

Returns Node


provider

provider name

Creates a Terraform provider block.

Parameters

  • name : string

Returns ContainerBuilder


provider_

provider_ ref

Creates a provider meta-argument reference (e.g. provider = aws.west).

Parameters

  • ref : string

Returns Node


provisioner

provisioner typeName

Creates a provisioner block (e.g. provisioner "local-exec" { ... }).

Parameters

  • typeName : string

Returns ContainerBuilder


removed_

removed_

Creates a Terraform removed block.

Returns ContainerBuilder


replace_triggered_by

replace_triggered_by refs

replace_triggered_by = [ref, ...] inside a lifecycle block.

Parameters

  • refs : string list

Returns Node


required_providers

required_providers

Creates a required_providers block inside a terraform block.

Returns ContainerBuilder


required_version

required_version value

Creates a required_version attribute inside a terraform block.

Parameters

  • value : string

Returns Node


resource

resource typeName name

Creates a Terraform resource block.

Parameters

  • typeName : string
  • name : string

Returns ContainerBuilder


sensitive

sensitive value

Creates a sensitive boolean attribute.

Parameters

  • value : bool

Returns Node


terraform

terraform

Creates a Terraform terraform block.

Returns ContainerBuilder


to_

to_ value

Creates a Terraform to expression attribute, used by import and moved.

Parameters

  • value : string

Returns Node


type_

type_ value

Creates a type attribute (e.g. type = string). Pass the HCL type expression as a raw string.

Parameters

  • value : string

Returns Node


validation

validation

Creates a validation block inside a variable block.

Returns ContainerBuilder


value_

value_ value

Creates a value attribute for an output block.

Parameters

  • value : Value

Returns Node


variable

variable name

Creates a Terraform variable block.

Parameters

  • name : string

Returns ContainerBuilder