interface ResolveOptions

Language	Type name
.NET	Amazon.CDK.ResolveOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2#ResolveOptions
Java	software.amazon.awscdk.ResolveOptions
Python	aws_cdk.ResolveOptions
TypeScript (source)	aws-cdk-lib » ResolveOptions

Options to the resolve() operation.

NOT the same as the ResolveContext; ResolveContext is exposed to Token implementors and resolution hooks, whereas this struct is just to bundle a number of things that would otherwise be arguments to resolve() in a readable way.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import * as constructs from 'constructs';

declare const construct: constructs.Construct;
declare const tokenResolver: cdk.ITokenResolver;
const resolveOptions: cdk.ResolveOptions = {
  resolver: tokenResolver,
  scope: construct,

  // the properties below are optional
  preparing: false,
  removeEmpty: false,
};

Properties

Name	Type	Description
resolver	ITokenResolver	The resolver to apply to any resolvable tokens found.
scope	IConstruct	The scope from which resolution is performed.
preparing?	boolean	Whether the resolution is being executed during the prepare phase or not.
removeEmpty?	boolean	Whether to remove undefined elements from arrays and objects when resolving.

---

resolver

Type: ITokenResolver

The resolver to apply to any resolvable tokens found.

---

scope

Type: IConstruct

The scope from which resolution is performed.

---

preparing?

Type: boolean (optional, default: false)

Whether the resolution is being executed during the prepare phase or not.

---

removeEmpty?

Type: boolean (optional, default: true)

Whether to remove undefined elements from arrays and objects when resolving.