Class ResolveOptions

Options to the resolve() operation.

Inheritance

object

ResolveOptions

Implements

IResolveOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ResolveOptions : IResolveOptions

Syntax (vb)

Public Class ResolveOptions Implements IResolveOptions

Remarks

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.

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Constructs;

             Construct construct;
             ITokenResolver tokenResolver;
             var resolveOptions = new ResolveOptions {
                 Resolver = tokenResolver,
                 Scope = construct,

                 // the properties below are optional
                 Preparing = false,
                 RemoveEmpty = false
             };

Synopsis

Constructors

ResolveOptions()

Options to the resolve() operation.

Properties

Preparing	Whether the resolution is being executed during the prepare phase or not.
RemoveEmpty	Whether to remove undefined elements from arrays and objects when resolving.
Resolver	The resolver to apply to any resolvable tokens found.
Scope	The scope from which resolution is performed.

Constructors

ResolveOptions()

Options to the resolve() operation.

public ResolveOptions()

Remarks

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.

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Constructs;

             Construct construct;
             ITokenResolver tokenResolver;
             var resolveOptions = new ResolveOptions {
                 Resolver = tokenResolver,
                 Scope = construct,

                 // the properties below are optional
                 Preparing = false,
                 RemoveEmpty = false
             };

Properties

Preparing

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

public bool? Preparing { get; set; }

Property Value

bool?

Remarks

Default: false

RemoveEmpty

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

public bool? RemoveEmpty { get; set; }

Property Value

bool?

Remarks

Default: true

Resolver

The resolver to apply to any resolvable tokens found.

public ITokenResolver Resolver { get; set; }

Property Value

ITokenResolver

Remarks

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.

ExampleMetadata: fixture=_generated

Scope

The scope from which resolution is performed.

public IConstruct Scope { get; set; }

Property Value

IConstruct

Remarks

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.

ExampleMetadata: fixture=_generated

Implements

IResolveOptions