Typescript: Token - CDK Terrain (CDKTN)

Represents a special or lazily-evaluated value. 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.

Initializers

import { Token } from 'cdktn'

new Token()

Name	Type	Description

Static Functions

Name	Description
`asAny`	Return a resolvable representation of the given value.
`asAnyMap`	Return a reversible map representation of this token.
`asBooleanMap`	Return a reversible map representation of this token.
`asList`	Return a reversible list representation of this token.
`asMap`	Return a reversible map representation of this token.
`asNumber`	Return a reversible number representation of this token.
`asNumberList`	Return a reversible list representation of this token.
`asNumberMap`	Return a reversible map representation of this token.
`asString`	Return a reversible string representation of this token.
`asStringMap`	Return a reversible map representation of this token.
`isUnresolved`	Returns true if obj represents an unresolved value.
`nullValue`	Return a Token containing a `null` value.

`asAny`

import { Token } from 'cdktn'

Token.asAny(value: any)

Return a resolvable representation of the given value.

`value`^Required

Type: any

`asAnyMap`

import { Token } from 'cdktn'

Token.asAnyMap(value: any, options?: EncodingOptions)

Return a reversible map representation of this token.

`value`^Required

Type: any

`options`^Optional

Type: EncodingOptions

`asBooleanMap`

import { Token } from 'cdktn'

Token.asBooleanMap(value: any, options?: EncodingOptions)

Return a reversible map representation of this token.

`value`^Required

Type: any

`options`^Optional

Type: EncodingOptions

`asList`

import { Token } from 'cdktn'

Token.asList(value: any, options?: EncodingOptions)

Return a reversible list representation of this token.

`value`^Required

Type: any

`options`^Optional

Type: EncodingOptions

`asMap`

import { Token } from 'cdktn'

Token.asMap(value: any, mapValue: any, options?: EncodingOptions)

Return a reversible map representation of this token.

`value`^Required

Type: any

`mapValue`^Required

Type: any

`options`^Optional

Type: EncodingOptions

`asNumber`

import { Token } from 'cdktn'

Token.asNumber(value: any)

Return a reversible number representation of this token.

`value`^Required

Type: any

`asNumberList`

import { Token } from 'cdktn'

Token.asNumberList(value: any)

Return a reversible list representation of this token.

`value`^Required

Type: any

`asNumberMap`

import { Token } from 'cdktn'

Token.asNumberMap(value: any, options?: EncodingOptions)

Return a reversible map representation of this token.

`value`^Required

Type: any

`options`^Optional

Type: EncodingOptions

`asString`

import { Token } from 'cdktn'

Token.asString(value: any, options?: EncodingOptions)

Return a reversible string representation of this token. 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.

`value`^Required

Type: any

`options`^Optional

Type: EncodingOptions

`asStringMap`

import { Token } from 'cdktn'

Token.asStringMap(value: any, options?: EncodingOptions)

Return a reversible map representation of this token.

`value`^Required

Type: any

`options`^Optional

Type: EncodingOptions

`isUnresolved`

import { Token } from 'cdktn'

Token.isUnresolved(obj: any)

Returns true if obj represents an unresolved value. One of these must be true:

obj is an IResolvable
obj is a string containing at least one encoded IResolvable
obj is either an encoded number or list

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

`obj`^Required

Type: any

The object to test.

`nullValue`

import { Token } from 'cdktn'

Token.nullValue()

Return a Token containing a null value. Note: This is different than undefined, nil, None or similar as it will end up in the Terraform config and can be used to explicitly not set an attribute (which is sometimes required by Terraform providers)

Constants

Name	Type	Description
`ANY_MAP_TOKEN_VALUE`	`string`	Any map token representation.
`NUMBER_MAP_TOKEN_VALUE`	`number`	Number Map token value representation.
`STRING_MAP_TOKEN_VALUE`	`string`	String Map token value representation.

`ANY_MAP_TOKEN_VALUE`^Required

public readonly ANY_MAP_TOKEN_VALUE: string;

Type: string

Any map token representation.

`NUMBER_MAP_TOKEN_VALUE`^Required

public readonly NUMBER_MAP_TOKEN_VALUE: number;

Type: number

Number Map token value representation.

`STRING_MAP_TOKEN_VALUE`^Required

public readonly STRING_MAP_TOKEN_VALUE: string;

Type: string

String Map token value representation.

Overview

TypeScript

Python

Java

C#

Go

​Initializers

​Static Functions

​asAny

​valueRequired

​asAnyMap

​valueRequired

​optionsOptional

​asBooleanMap

​valueRequired

​optionsOptional

​asList

​valueRequired

​optionsOptional

​asMap

​valueRequired

​mapValueRequired

​optionsOptional

​asNumber

​valueRequired

​asNumberList

​valueRequired

​asNumberMap

​valueRequired

​optionsOptional

​asString

​valueRequired

​optionsOptional

​asStringMap

​valueRequired

​optionsOptional

​isUnresolved

​objRequired

​nullValue

​Constants

​ANY_MAP_TOKEN_VALUERequired

​NUMBER_MAP_TOKEN_VALUERequired

​STRING_MAP_TOKEN_VALUERequired

Initializers

Static Functions

`asAny`

`value`^Required

`asAnyMap`

`value`^Required

`options`^Optional

`asBooleanMap`

`value`^Required

`options`^Optional

`asList`

`value`^Required

`options`^Optional

`asMap`

`value`^Required

`mapValue`^Required

`options`^Optional

`asNumber`

`value`^Required

`asNumberList`

`value`^Required

`asNumberMap`

`value`^Required

`options`^Optional

`asString`

`value`^Required

`options`^Optional

`asStringMap`

`value`^Required

`options`^Optional

`isUnresolved`

`obj`^Required

`nullValue`

Constants

`ANY_MAP_TOKEN_VALUE`^Required

`NUMBER_MAP_TOKEN_VALUE`^Required

`STRING_MAP_TOKEN_VALUE`^Required