Package software.amazon.awscdk

Interface ResolveOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ResolveOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:02.236Z")
@Stability(Stable)
public interface ResolveOptions
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.*;
 import software.constructs.*;
 Construct construct;
 ITokenResolver tokenResolver;
 ResolveOptions resolveOptions = ResolveOptions.builder()
         .resolver(tokenResolver)
         .scope(construct)
         // the properties below are optional
         .preparing(false)
         .removeEmpty(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ResolveOptions.Builder	A builder for ResolveOptions
static final class	ResolveOptions.Jsii$Proxy	An implementation for ResolveOptions

Method Summary

Modifier and Type	Method	Description
static ResolveOptions.Builder	builder()
default Boolean	getPreparing()	Whether the resolution is being executed during the prepare phase or not.
default Boolean	getRemoveEmpty()	Whether to remove undefined elements from arrays and objects when resolving.
ITokenResolver	getResolver()	The resolver to apply to any resolvable tokens found.
software.constructs.IConstruct	getScope()	The scope from which resolution is performed.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResolver

@Stability(Stable)
@NotNull
ITokenResolver getResolver()

The resolver to apply to any resolvable tokens found.

getScope

@Stability(Stable)
@NotNull
software.constructs.IConstruct getScope()

The scope from which resolution is performed.

getPreparing

@Stability(Stable)
@Nullable
default Boolean getPreparing()

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

Default: false

getRemoveEmpty

@Stability(Stable)
@Nullable
default Boolean getRemoveEmpty()

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

Default: true

builder

@Stability(Stable)
static ResolveOptions.Builder builder()

Returns:

a ResolveOptions.Builder of ResolveOptions