Reference

class aws_cdk.Reference(value, target, display_name=None, type_hint=None)

Bases: Intrinsic

An intrinsic Token that represents a reference to a construct.

References are recorded.

Parameters:

• value (Any) –

• target (IConstruct) –

• display_name (Optional[str]) –

• type_hint (Optional[ResolutionTypeHint]) – Type that the Intrinsic is expected to evaluate to.

Methods

resolve(_context)

Produce the Token’s value at resolution time.

Parameters:

_context (IResolveContext) –

Return type:

Any

to_json()

Turn this Token into JSON.

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

Return type:

Any

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

Return type:

str

to_string_list()

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.

Return type:

List[str]

Attributes

creation_stack

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

display_name

target

type_hint

Type that the Intrinsic is expected to evaluate to.

Static Methods

classmethod is_reference(x)

Check whether this is actually a Reference.

Parameters:

x (Any) –

Return type:

bool