software.amazon.awscdk.core

Interface ResolveOptions

All Known Implementing Classes:

ResolveOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:19:53.115Z")
public interface 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 software.amazon.awscdk.core.*;
 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 and Description
static class	ResolveOptions.Builder A builder for ResolveOptions
static class	ResolveOptions.Jsii$Proxy An implementation for ResolveOptions

Method Summary

Modifier and Type	Method and Description
static ResolveOptions.Builder	builder()
default java.lang.Boolean	getPreparing() Whether the resolution is being executed during the prepare phase or not.
default java.lang.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.

Method Detail

getResolver

ITokenResolver getResolver()

The resolver to apply to any resolvable tokens found.

getScope

software.constructs.IConstruct getScope()

The scope from which resolution is performed.

getPreparing

default java.lang.Boolean getPreparing()

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

Default: false

getRemoveEmpty

default java.lang.Boolean getRemoveEmpty()

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

Default: true

builder

static ResolveOptions.Builder builder()

Returns:

a ResolveOptions.Builder of ResolveOptions