Typescript: IResolveContext

CDKTN Core API Reference for IResolveContext in Typescript.

• Implemented By: IResolveContext

Current resolution context for tokens.

Methods

Name	Description
registerPostProcessor	Use this postprocessor after the entire token structure has been resolved.
resolve	Resolve an inner object.

---

registerPostProcessor

public registerPostProcessor(postProcessor: IPostProcessor): void

Use this postprocessor after the entire token structure has been resolved.

postProcessor^Required

• Type: IPostProcessor

---

resolve

public resolve(x: any): any

Resolve an inner object.

x^Required

• Type: any

---

Properties

Name	Type	Description
preparing	boolean	True when we are still preparing, false if we’re rendering the final output.
scope	constructs.IConstruct	The scope from which resolution has been initiated.
ignoreEscapes	boolean	True when ${} should not be parsed, and treated as literals.
iteratorContext	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.
suppressBraces	boolean	True when ${} should be ommitted (because already inside them), false otherwise.
warnEscapes	boolean	True when ${} should not be included in the string to be resolved, outputs a warning.

---

preparing^Required

public readonly preparing: boolean;

• Type: boolean

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

---

scope^Required

public readonly scope: IConstruct;

• Type: constructs.IConstruct

The scope from which resolution has been initiated.

---

ignoreEscapes^Optional

public readonly ignoreEscapes: boolean;

• Type: boolean

True when ${} should not be parsed, and treated as literals.

---

iteratorContext^Optional

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.

---

suppressBraces^Optional

public readonly suppressBraces: boolean;

• Type: boolean

True when ${} should be ommitted (because already inside them), false otherwise.

---

warnEscapes^Optional

public readonly warnEscapes: boolean;

• Type: boolean

True when ${} should not be included in the string to be resolved, outputs a warning.

Default: false

---