Values

HCL value constructors and conversions.

FunctionDescription
bool valueCreates an HCL boolean value.
boolField key valueCreates a boolean object field.
call name argumentsCreates an HCL function call expression.
conditional condition trueExpr falseExprCreates a conditional expression value.
escapeString valueEscapes a string for use as an HCL string literal.
escapeTemplateString valueEscapes a template string, preserving ${...} and %{...} interpolation sequences.
expr valueMarks a string as a raw HCL expression when converting CLR or F# values.
field key valueCreates an object field.
forObject keyVar valueVar collection keyExpr valueExprCreates a for-object expression value, for example {for k, v in map : k => v}.
forObjectGroup keyVar valueVar collection keyExpr valueExprCreates a for-object expression value with grouping mode (...).
forObjectIf keyVar valueVar collection keyExpr valueExpr conditionCreates a for-object expression value with a condition filter.
forTuple variable collection exprCreates a for-tuple expression value, for example [for v in list : v.id].
forTupleIf variable collection expr conditionCreates a for-tuple expression value with a condition filter.
heredoc delimiter contentCreates a heredoc string value.
heredocIndent delimiter contentCreates an indented heredoc string value (<<- syntax).
jsonencode valueCreates a Terraform jsonencode(...) expression from a CLR or F# value.
null_Creates an HCL null value.
number valueCreates an HCL number value from a CLR numeric value.
numberField key valueCreates a number object field.
objHCL object value computation expression.
objField keyCreates an object-valued field with a computation expression.
ofRecord recordConverts a record into an HCL object value.
ofValue valueConverts a record, primitive value, sequence, dictionary, or Expr into an HCL value.
raw valueCreates a raw HCL expression value.
rawField key valueCreates a raw expression object field.
str valueCreates an HCL string value.
stringField key valueCreates a string object field.
templateStr valueCreates a template string value (preserves ${...} interpolation sequences).

bool

bool value

Creates an HCL boolean value.

Parameters

  • value : bool

Returns Value


boolField

boolField key value

Creates a boolean object field.

Parameters

  • key : 'a
  • value : bool

Returns 'a * Value


call

call name arguments

Creates an HCL function call expression.

Parameters

  • name : string
  • arguments : Value list

Returns Value


conditional

conditional condition trueExpr falseExpr

Creates a conditional expression value.

Parameters

  • condition : string
  • trueExpr : string
  • falseExpr : string

Returns Value


escapeString

escapeString value

Escapes a string for use as an HCL string literal.

Parameters

  • value : string

Returns string


escapeTemplateString

escapeTemplateString value

Escapes a template string, preserving ${...} and %{...} interpolation sequences.

Parameters

  • value : string

Returns string


expr

expr value

Marks a string as a raw HCL expression when converting CLR or F# values.

Parameters

  • value : string

Returns Expr


field

field key value

Creates an object field.

Parameters

  • key : 'a
  • value : 'b

Returns 'a * 'b


forObject

forObject keyVar valueVar collection keyExpr valueExpr

Creates a for-object expression value, for example {for k, v in map : k => v}.

Parameters

  • keyVar : string
  • valueVar : string
  • collection : string
  • keyExpr : string
  • valueExpr : string

Returns Value


forObjectGroup

forObjectGroup keyVar valueVar collection keyExpr valueExpr

Creates a for-object expression value with grouping mode (...).

Parameters

  • keyVar : string
  • valueVar : string
  • collection : string
  • keyExpr : string
  • valueExpr : string

Returns Value


forObjectIf

forObjectIf keyVar valueVar collection keyExpr valueExpr condition

Creates a for-object expression value with a condition filter.

Parameters

  • keyVar : string
  • valueVar : string
  • collection : string
  • keyExpr : string
  • valueExpr : string
  • condition : string

Returns Value


forTuple

forTuple variable collection expr

Creates a for-tuple expression value, for example [for v in list : v.id].

Parameters

  • variable : string
  • collection : string
  • expr : string

Returns Value


forTupleIf

forTupleIf variable collection expr condition

Creates a for-tuple expression value with a condition filter.

Parameters

  • variable : string
  • collection : string
  • expr : string
  • condition : string

Returns Value


heredoc

heredoc delimiter content

Creates a heredoc string value.

Parameters

  • delimiter : string
  • content : string

Returns Value


heredocIndent

heredocIndent delimiter content

Creates an indented heredoc string value (<<- syntax).

Parameters

  • delimiter : string
  • content : string

Returns Value


jsonencode

jsonencode value

Creates a Terraform jsonencode(...) expression from a CLR or F# value.

Parameters

  • value : 'a

Returns Value


null_

null_

Creates an HCL null value.

Returns Value


number

number value

Creates an HCL number value from a CLR numeric value.

Parameters

  • value : 'a

Returns Value


numberField

numberField key value

Creates a number object field.

Parameters

  • key : 'a
  • value : 'b

Returns 'a * Value


obj

obj

HCL object value computation expression.

Returns ObjectBuilder


objField

objField key

Creates an object-valued field with a computation expression.

Parameters

  • key : string

Returns ObjectFieldBuilder


ofRecord

ofRecord record

Converts a record into an HCL object value.

Parameters

  • record : 'a

Returns Value


ofValue

ofValue value

Converts a record, primitive value, sequence, dictionary, or Expr into an HCL value.

Parameters

  • value : 'a

Returns Value


raw

raw value

Creates a raw HCL expression value.

Parameters

  • value : string

Returns Value


rawField

rawField key value

Creates a raw expression object field.

Parameters

  • key : 'a
  • value : string

Returns 'a * Value


str

str value

Creates an HCL string value.

Parameters

  • value : string

Returns Value


stringField

stringField key value

Creates a string object field.

Parameters

  • key : 'a
  • value : string

Returns 'a * Value


templateStr

templateStr value

Creates a template string value (preserves ${...} interpolation sequences).

Parameters

  • value : string

Returns Value