Python: Tokenization

CDKTN Core API Reference for Tokenization in Python.

Less oft-needed functions to manipulate Tokens.

Initializers

import cdktn

cdktn.Tokenization()

Name	Type	Description

---

Static Functions

Name	Description
is_resolvable	Return whether the given object is an IResolvable object.
resolve	Resolves an object by evaluating all tokens and removing any undefined or empty objects or arrays.
reverse	Reverse any value into Resolvables, if possible.
reverse_list	Un-encode a Tokenized value from a list.
reverse_map	Un-encode a Tokenized value from a map.
reverse_number	Un-encode a Tokenized value from a number.
reverse_number_list	Un-encode a Tokenized value from a list.
reverse_string	Un-encode a string potentially containing encoded tokens.
stringify_number	Stringify 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.

obj^Required

• 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.

obj^Required

• Type: typing.Any

The object to resolve.

---

resolver^Required

• Type: ITokenResolver

The resolver to apply to any resolvable tokens found.

---

scope^Required

• Type: constructs.IConstruct

The scope from which resolution is performed.

---

preparing^Optional

• 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.

x^Required

• Type: typing.Any

---

reverse_list

import cdktn

cdktn.Tokenization.reverse_list(
  l: typing.List[str]
)

Un-encode a Tokenized value from a list.

l^Required

• 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.

m^Required

• 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.

n^Required

• 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.

l^Required

• 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.

s^Required

• 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.

x^Required

• Type: typing.Union[int, float]

---