FnRef

The intrinsic function Ref returns the value of the specified parameter or resource.

When you specify a parameter's logical name, it returns the value of the parameter. When you specify a resource's logical name, it returns a value that you can typically use to refer to that resource, such as a physical ID.

Initializers

import ros_cdk_core
ros_cdk_core.FnRef(
  logical_name: str
)

Name	Type	Description
logical_name	str	The logical name of a parameter/resource for which you want to retrieve its value.

---

logical_name^Required

• Type: str

The logical name of a parameter/resource for which you want to retrieve its value.

---

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.

Properties

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

---

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.

---