Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Current resolution context for tokens.

​
Methods

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

​
registerPostProcessor 

public registerPostProcessor(postProcessor: IPostProcessor): void
Use this postprocessor after the entire token structure has been resolved.

​
postProcessorRequired

​
resolve 

public resolve(x: any): any
Resolve an inner object.

​
xRequired

  • Type: any

​
Properties

NameTypeDescription
preparingbooleanTrue when we are still preparing, false if we’re rendering the final output.
scopeconstructs.IConstructThe scope from which resolution has been initiated.
ignoreEscapesbooleanTrue when ${} should not be parsed, and treated as literals.
iteratorContextstringTerraformIterators 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.
suppressBracesbooleanTrue when ${} should be ommitted (because already inside them), false otherwise.
warnEscapesbooleanTrue when ${} should not be included in the string to be resolved, outputs a warning.

​
preparingRequired 

public readonly preparing: boolean;
  • Type: boolean
True when we are still preparing, false if we’re rendering the final output.

​
scopeRequired 

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

​
ignoreEscapesOptional 

public readonly ignoreEscapes: boolean;
  • Type: boolean
True when ${} should not be parsed, and treated as literals.

​
iteratorContextOptional 

public readonly iteratorContext: string;
  • Type: string
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.

​
suppressBracesOptional 

public readonly suppressBraces: boolean;
  • Type: boolean
True when ${} should be ommitted (because already inside them), false otherwise.

​
warnEscapesOptional 

public readonly warnEscapes: boolean;
  • Type: boolean
True when ${} should not be included in the string to be resolved, outputs a warning. Default: false