aws-cdk-lib.Intrinsic

class Intrinsic

LanguageType name
.NETAmazon.CDK.Intrinsic
Gogithub.com/aws/aws-cdk-go/awscdk/v2#Intrinsic
Javasoftware.amazon.awscdk.Intrinsic
Pythonaws_cdk.Intrinsic
TypeScript (source)aws-cdk-lib » Intrinsic

Implements IResolvable

Token subclass that represents values intrinsic to the target document language.

WARNING: this class should not be externally exposed, but is currently visible because of a limitation of jsii (https://github.com/aws/jsii/issues/524).

This class will disappear in a future release and should not be used.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';

declare const value: any;
const intrinsic = new cdk.Intrinsic(value, /* all optional props */ {
  stackTrace: false,
  typeHint: cdk.ResolutionTypeHint.STRING,
});

Initializer

new Intrinsic(value: any, options?: IntrinsicProps)

Parameters

  • value any
  • options IntrinsicProps

Properties

NameTypeDescription
creationStackstring[]The captured stack trace which represents the location in which this token was created.
typeHint?ResolutionTypeHintType that the Intrinsic is expected to evaluate to.

creationStack

Type: string[]

The captured stack trace which represents the location in which this token was created.


typeHint?

Type: ResolutionTypeHint (optional)

Type that the Intrinsic is expected to evaluate to.

Methods

NameDescription
resolve(_context)Produce the Token's value at resolution time.
toJSON()Turn this Token into JSON.
toString()Convert an instance of this Token to a string.
toStringList()Convert an instance of this Token to a string list.
protected newError(message)Creates a throwable Error object that contains the token creation stack trace.

resolve(_context)

public resolve(_context: IResolveContext): any

Parameters

  • _context IResolveContext

Returns

  • any

Produce the Token's value at resolution time.


toJSON()

public toJSON(): any

Returns

  • any

Turn this Token into JSON.

Called automatically when JSON.stringify() is called on a Token.


toString()

public toString(): string

Returns

  • string

Convert an instance of this Token to a string.

This method will be called implicitly by language runtimes if the object is embedded into a string. We treat it the same as an explicit stringification.


toStringList()

public toStringList(): string[]

Returns

  • string[]

Convert an instance of this Token to a string list.

This method will be called implicitly by language runtimes if the object is embedded into a list. We treat it the same as an explicit stringification.


protected newError(message)

protected newError(message: string): any

Parameters

  • message string — Error message.

Returns

  • any

Creates a throwable Error object that contains the token creation stack trace.