Go: 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 "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.NewToken() 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 "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsAny(value interface{}) IResolvable

Return a resolvable representation of the given value.

`value`^Required

Type: interface{}

`AsAnyMap`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsAnyMap(value interface{}, options EncodingOptions) *map[string]interface{}

Return a reversible map representation of this token.

`value`^Required

Type: interface{}

`options`^Optional

Type: EncodingOptions

`AsBooleanMap`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsBooleanMap(value interface{}, options EncodingOptions) *map[string]*bool

Return a reversible map representation of this token.

`value`^Required

Type: interface{}

`options`^Optional

Type: EncodingOptions

`AsList`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsList(value interface{}, options EncodingOptions) *[]*string

Return a reversible list representation of this token.

`value`^Required

Type: interface{}

`options`^Optional

Type: EncodingOptions

`AsMap`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsMap(value interface{}, mapValue interface{}, options EncodingOptions) *map[string]interface{}

Return a reversible map representation of this token.

`value`^Required

Type: interface{}

`mapValue`^Required

Type: interface{}

`options`^Optional

Type: EncodingOptions

`AsNumber`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsNumber(value interface{}) *f64

Return a reversible number representation of this token.

`value`^Required

Type: interface{}

`AsNumberList`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsNumberList(value interface{}) *[]*f64

Return a reversible list representation of this token.

`value`^Required

Type: interface{}

`AsNumberMap`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsNumberMap(value interface{}, options EncodingOptions) *map[string]*f64

Return a reversible map representation of this token.

`value`^Required

Type: interface{}

`options`^Optional

Type: EncodingOptions

`AsString`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsString(value interface{}, options EncodingOptions) *string

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: interface{}

`options`^Optional

Type: EncodingOptions

`AsStringMap`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_AsStringMap(value interface{}, options EncodingOptions) *map[string]*string

Return a reversible map representation of this token.

`value`^Required

Type: interface{}

`options`^Optional

Type: EncodingOptions

`IsUnresolved`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_IsUnresolved(obj interface{}) *bool

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: interface{}

The object to test.

`NullValue`

import "github.com/open-constructs/cdk-terrain-go/cdktn"

cdktn.Token_NullValue() IResolvable

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
`AnyMapTokenValue`	`*string`	Any map token representation.
`NumberMapTokenValue`	`*f64`	Number Map token value representation.
`StringMapTokenValue`	`*string`	String Map token value representation.

`AnyMapTokenValue`^Required

func AnyMapTokenValue() *string

Type: *string

Any map token representation.

`NumberMapTokenValue`^Required

func NumberMapTokenValue() *f64

Type: *f64

Number Map token value representation.

`StringMapTokenValue`^Required

func StringMapTokenValue() *string

Type: *string

String Map token value representation.

​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

​AnyMapTokenValueRequired

​NumberMapTokenValueRequired

​StringMapTokenValueRequired

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

`AnyMapTokenValue`^Required

`NumberMapTokenValue`^Required

`StringMapTokenValue`^Required