aws-cdk-lib.ResolveOptions

ResolveOptions Struct

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.

Source

core/lib/token.ts

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

preparing?optionalbooleanpreparing?optionalboolpreparing?optionalBooleanPreparing?optionalboolPreparing?optional*bool= false#

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

removeEmpty?optionalbooleanremove_empty?optionalboolremoveEmpty?optionalBooleanRemoveEmpty?optionalboolRemoveEmpty?optional*bool= true#

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

resolverITokenResolverresolverITokenResolverresolverITokenResolverResolverITokenResolverResolverITokenResolverrequired#

The resolver to apply to any resolvable tokens found.

scopeIConstructscopeIConstructscopeIConstructScopeIConstructScopeIConstructrequired#

The scope from which resolution is performed.