Skip to main content
Less oft-needed functions to manipulate Tokens.

Initializers

import cdktn

cdktn.Tokenization()
NameTypeDescription

Static Functions

NameDescription
is_resolvableReturn whether the given object is an IResolvable object.
resolveResolves an object by evaluating all tokens and removing any undefined or empty objects or arrays.
reverseReverse any value into Resolvables, if possible.
reverse_listUn-encode a Tokenized value from a list.
reverse_mapUn-encode a Tokenized value from a map.
reverse_numberUn-encode a Tokenized value from a number.
reverse_number_listUn-encode a Tokenized value from a list.
reverse_stringUn-encode a string potentially containing encoded tokens.
stringify_numberStringify a number directly or lazily if it’s a Token.

is_resolvable

import cdktn

cdktn.Tokenization.is_resolvable(
  obj: typing.Any
)
Return whether the given object is an IResolvable object. This is different from Token.isUnresolved() which will also check for encoded Tokens, whereas this method will only do a type check on the given object.

objRequired

  • Type: typing.Any

resolve

import cdktn

cdktn.Tokenization.resolve(
  obj: typing.Any,
  resolver: ITokenResolver,
  scope: IConstruct,
  preparing: bool = None
)
Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays. Values can only be primitives, arrays or tokens. Other objects (i.e. with methods) will be rejected.

objRequired

  • Type: typing.Any
The object to resolve.

resolverRequired

The resolver to apply to any resolvable tokens found.

scopeRequired

  • Type: constructs.IConstruct
The scope from which resolution is performed.

preparingOptional

  • Type: bool
  • Default: false
Whether the resolution is being executed during the prepare phase or not.

reverse

import cdktn

cdktn.Tokenization.reverse(
  x: typing.Any
)
Reverse any value into Resolvables, if possible.

xRequired

  • Type: typing.Any

reverse_list

import cdktn

cdktn.Tokenization.reverse_list(
  l: typing.List[str]
)
Un-encode a Tokenized value from a list.

lRequired

  • Type: typing.List[str]

reverse_map

import cdktn

cdktn.Tokenization.reverse_map(
  m: typing.Mapping[typing.Any]
)
Un-encode a Tokenized value from a map.

mRequired

  • Type: typing.Mapping[typing.Any]

reverse_number

import cdktn

cdktn.Tokenization.reverse_number(
  n: typing.Union[int, float]
)
Un-encode a Tokenized value from a number.

nRequired

  • Type: typing.Union[int, float]

reverse_number_list

import cdktn

cdktn.Tokenization.reverse_number_list(
  l: typing.List[typing.Union[int, float]]
)
Un-encode a Tokenized value from a list.

lRequired

  • Type: typing.List[typing.Union[int, float]]

reverse_string

import cdktn

cdktn.Tokenization.reverse_string(
  s: str
)
Un-encode a string potentially containing encoded tokens.

sRequired

  • Type: str

stringify_number

import cdktn

cdktn.Tokenization.stringify_number(
  x: typing.Union[int, float]
)
Stringify a number directly or lazily if it’s a Token. If it is an object (i.e., { Ref: ‘SomeLogicalId’ }), return it as-is.

xRequired

  • Type: typing.Union[int, float]