Skip to main content
Current resolution context for tokens.

Methods

NameDescription
register_post_processorUse this postprocessor after the entire token structure has been resolved.
resolveResolve an inner object.

register_post_processor

def register_post_processor(
  post_processor: IPostProcessor
) -> None
Use this postprocessor after the entire token structure has been resolved.

post_processorRequired


resolve

def resolve(
  x: typing.Any
) -> typing.Any
Resolve an inner object.

xRequired

  • Type: typing.Any

Properties

NameTypeDescription
preparingboolTrue when we are still preparing, false if we’re rendering the final output.
scopeconstructs.IConstructThe scope from which resolution has been initiated.
ignore_escapesboolTrue when ${} should not be parsed, and treated as literals.
iterator_contextstrTerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.
suppress_bracesboolTrue when ${} should be ommitted (because already inside them), false otherwise.
warn_escapesboolTrue when ${} should not be included in the string to be resolved, outputs a warning.

preparingRequired

preparing: bool
  • Type: bool
True when we are still preparing, false if we’re rendering the final output.

scopeRequired

scope: IConstruct
  • Type: constructs.IConstruct
The scope from which resolution has been initiated.

ignore_escapesOptional

ignore_escapes: bool
  • Type: bool
True when ${} should not be parsed, and treated as literals.

iterator_contextOptional

iterator_context: str
  • Type: str
TerraformIterators can be passed for block attributes and normal list attributes both require different handling when the iterable variable is accessed e.g. a dynamic block needs each.key while a for expression just needs key.

suppress_bracesOptional

suppress_braces: bool
  • Type: bool
True when ${} should be ommitted (because already inside them), false otherwise.

warn_escapesOptional

warn_escapes: bool
  • Type: bool
True when ${} should not be included in the string to be resolved, outputs a warning. Default: false