RosOutput

Initializers

import ros_cdk_core
ros_cdk_core.RosOutput(
  scope: Construct,
  id: str,
  value: typing.Any,
  condition: RosCondition = None,
  description: str = None,
  export_name: str = None
)

Name	Type	Description
scope	Construct	The parent construct.
id	str	No description.
value	typing.Any	The value of the property returned by Resource Orchestration Service.
condition	RosCondition	A condition to associate with this output value.
description	str	A String type that describes the output value.
export_name	str	The name used to export the value of this output across stacks.

---

scope^Required

• Type: Construct

The parent construct.

---

id^Required

• Type: str

---

value^Required

• Type: typing.Any

The value of the property returned by Resource Orchestration Service.

The value of an output can include literals, parameter references, pseudo-parameters, a mapping value, or intrinsic functions.

---

condition^Optional

• Type: RosCondition
• Default: No condition is associated with the output.

A condition to associate with this output value.

If the condition evaluates to false, this output value will not be included in the stack.

---

description^Optional

• Type: str
• Default: No description.

A String type that describes the output value.

The description can be a maximum of 4 K in length.

---

export_name^Optional

• Type: str
• Default: the output is not exported

The name used to export the value of this output across stacks.

To import the value from another stack, use Fn.importValue(exportName).

---

Methods

Name	Description
to_string	Returns a string representation of this construct.
synthesize	Allows this construct to emit artifacts into the cloud assembly during synthesis.
override_logical_id	Overrides the auto-generated logical ID with a specific ID.
add_condition	No description.

---

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ISynthesisSession

The synthesis session.

---

override_logical_id

def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_id^Required

• Type: str

The new logical ID to use for this stack element.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: RosCondition

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.
is_ros_element	Returns true if a construct is a stack element (i.e. part of the synthesized template).

---

is_construct

import ros_cdk_core
ros_cdk_core.RosOutput.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

is_ros_element

import ros_cdk_core
ros_cdk_core.RosOutput.is_ros_element(
  x: typing.Any
)

Returns true if a construct is a stack element (i.e. part of the synthesized template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ConstructNode	The construct tree node associated with this construct.
creation_stack	typing.List[str]	No description.
logical_id	str	The logical ID for this stack element.
stack	Stack	The stack in which this element is defined.

---

node^Required

node: ConstructNode

• Type: ConstructNode

The construct tree node associated with this construct.

---

creation_stack^Required

creation_stack: typing.List[str]

• Type: typing.List[str]

---

logical_id^Required

logical_id: str

• Type: str

The logical ID for this stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

---

stack^Required

stack: Stack

• Type: Stack

The stack in which this element is defined.

RosElements must be defined within a stack scope (directly or indirectly).

---