Documentation Index
Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt
Use this file to discover all available pages before exploring further.
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 io.cdktn.cdktn.Token;
new Token();
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 io.cdktn.cdktn.Token;
Token.asAny(java.lang.Object value)
Return a resolvable representation of the given value.
valueRequired
asAnyMap
import io.cdktn.cdktn.Token;
Token.asAnyMap(java.lang.Object value),Token.asAnyMap(java.lang.Object value, EncodingOptions options)
Return a reversible map representation of this token.
valueRequired
optionsOptional
asBooleanMap
import io.cdktn.cdktn.Token;
Token.asBooleanMap(java.lang.Object value),Token.asBooleanMap(java.lang.Object value, EncodingOptions options)
Return a reversible map representation of this token.
valueRequired
optionsOptional
asList
import io.cdktn.cdktn.Token;
Token.asList(java.lang.Object value),Token.asList(java.lang.Object value, EncodingOptions options)
Return a reversible list representation of this token.
valueRequired
optionsOptional
asMap
import io.cdktn.cdktn.Token;
Token.asMap(java.lang.Object value, java.lang.Object mapValue),Token.asMap(java.lang.Object value, java.lang.Object mapValue, EncodingOptions options)
Return a reversible map representation of this token.
valueRequired
mapValueRequired
optionsOptional
asNumber
import io.cdktn.cdktn.Token;
Token.asNumber(java.lang.Object value)
Return a reversible number representation of this token.
valueRequired
asNumberList
import io.cdktn.cdktn.Token;
Token.asNumberList(java.lang.Object value)
Return a reversible list representation of this token.
valueRequired
asNumberMap
import io.cdktn.cdktn.Token;
Token.asNumberMap(java.lang.Object value),Token.asNumberMap(java.lang.Object value, EncodingOptions options)
Return a reversible map representation of this token.
valueRequired
optionsOptional
asString
import io.cdktn.cdktn.Token;
Token.asString(java.lang.Object value),Token.asString(java.lang.Object value, EncodingOptions options)
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.
valueRequired
optionsOptional
asStringMap
import io.cdktn.cdktn.Token;
Token.asStringMap(java.lang.Object value),Token.asStringMap(java.lang.Object value, EncodingOptions options)
Return a reversible map representation of this token.
valueRequired
optionsOptional
isUnresolved
import io.cdktn.cdktn.Token;
Token.isUnresolved(java.lang.Object obj)
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.
objRequired
The object to test.
nullValue
import io.cdktn.cdktn.Token;
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 | java.lang.String | Any map token representation. |
NUMBER_MAP_TOKEN_VALUE | java.lang.Number | Number Map token value representation. |
STRING_MAP_TOKEN_VALUE | java.lang.String | String Map token value representation. |
ANY_MAP_TOKEN_VALUERequired
public java.lang.String getAnyMapTokenValue();
Any map token representation.
NUMBER_MAP_TOKEN_VALUERequired
public java.lang.Number getNumberMapTokenValue();
Number Map token value representation.
STRING_MAP_TOKEN_VALUERequired
public java.lang.String getStringMapTokenValue();
String Map token value representation.