Reference

An intrinsic Token that represents a reference to a construct.

References are recorded.

Initializers

import ros_cdk_core
ros_cdk_core.Reference(
  value: typing.Any,
  target: IConstruct,
  display_name: str = None
)

Name	Type	Description
value	typing.Any	No description.
target	IConstruct	No description.
display_name	str	No description.

---

value^Required

• Type: typing.Any

---

target^Required

• Type: IConstruct

---

display_name^Optional

• Type: str

---

Methods

Name	Description
resolve	Produce the Token's value at resolution time.
to_jso_n	Turn this Token into JSON.
to_string	Convert an instance of this Token to a string.

---

resolve

def resolve(
  _context: IResolveContext
) -> typing.Any

Produce the Token's value at resolution time.

_context^Required

• Type: IResolveContext

---

to_jso_n

def to_jso_n() -> typing.Any

Turn this Token into JSON.

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

to_string

def to_string() -> str

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.

Static Functions

Name	Description
is_reference	Check whether this is actually a Reference.

---

is_reference

import ros_cdk_core
ros_cdk_core.Reference.is_reference(
  x: typing.Any
)

Check whether this is actually a Reference.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
creation_stack	typing.List[str]	The captured stack trace which represents the location in which this token was created.
display_name	str	No description.
target	IConstruct	No description.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

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

---

display_name^Required

display_name: str

• Type: str

---

target^Required

target: IConstruct

• Type: IConstruct

---