Class Token

Represents a special or lazily-evaluated value.

Inheritance

System.Object

Token

Namespace: Amazon.CDK

Assembly: Amazon.CDK.dll

Syntax (csharp)

public class Token : DeputyBase

Syntax (vb)

Public Class Token
    Inherits DeputyBase

Remarks

Can be used to delay evaluation of a certain value in case, for example, that it requires some context or late-bound data. Can also be used to mark values that need special processing at document rendering time.

Tokens can be embedded into strings while retaining their original semantics.

Stability: Stable

Synopsis

Constructors

Token(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
Token(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Methods

AsAny(Object)	Return a resolvable representation of the given value.
AsList(Object, IEncodingOptions)	Return a reversible list representation of this token.
AsNumber(Object)	Return a reversible number representation of this token.
AsString(Object, IEncodingOptions)	Return a reversible string representation of this token.
IsUnresolved(Object)	Returns true if obj represents an unresolved value.

Constructors

Token(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected Token(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

Token(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected Token(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Methods

AsAny(Object)

Return a resolvable representation of the given value.

public static IResolvable AsAny(object value)

Parameters

value System.Object

Returns

IResolvable

Remarks

Stability: Stable

AsList(Object, IEncodingOptions)

Return a reversible list representation of this token.

public static string[] AsList(object value, IEncodingOptions options = null)

Parameters

value System.Object

options IEncodingOptions

Returns

System.String[]

Remarks

Stability: Stable

AsNumber(Object)

Return a reversible number representation of this token.

public static double AsNumber(object value)

Parameters

value System.Object

Returns

System.Double

Remarks

Stability: Stable

AsString(Object, IEncodingOptions)

Return a reversible string representation of this token.

public static string AsString(object value, IEncodingOptions options = null)

Parameters

value System.Object

options IEncodingOptions

Returns

System.String

Remarks

If the Token is initialized with a literal, the stringified value of the literal is returned. Otherwise, a special quoted string representation of the Token is returned that can be embedded into other strings.

Strings with quoted Tokens in them can be restored back into complex values with the Tokens restored by calling resolve() on the string.

Stability: Stable

IsUnresolved(Object)

Returns true if obj represents an unresolved value.

public static bool IsUnresolved(object obj)

Parameters

obj System.Object

The object to test.

Returns

System.Boolean

Remarks

One of these must be true:

This does NOT recurse into lists or objects to see if they containing resolvables.

Stability: Stable