RosParameter

A ROS parameter.

Parameters enable you to input custom values to your template each time you create or update a stack.

Initializers

import ros_cdk_core
ros_cdk_core.RosParameter(
  scope: Construct,
  id: str,
  allowed_pattern: str = None,
  allowed_values: typing.List[typing.Any] = None,
  association_property: str = None,
  association_property_metadata: typing.Mapping[typing.Any] = None,
  confirm: bool = None,
  constraint_description: typing.Union[str, typing.Mapping[str]] = None,
  default_value: typing.Any = None,
  description: typing.Union[str, typing.Mapping[str]] = None,
  label: str = None,
  max_length: typing.Union[int, float] = None,
  max_value: typing.Union[int, float] = None,
  min_length: typing.Union[int, float] = None,
  min_value: typing.Union[int, float] = None,
  no_echo: bool = None,
  text_area: bool = None,
  type: RosParameterType = None
)

Name	Type	Description
scope	Construct	No description.
id	str	No description.
allowed_pattern	str	No description.
allowed_values	typing.List[typing.Any]	No description.
association_property	str	No description.
association_property_metadata	typing.Mapping[typing.Any]	No description.
confirm	bool	No description.
constraint_description	typing.Union[str, typing.Mapping[str]]	No description.
default_value	typing.Any	No description.
description	typing.Union[str, typing.Mapping[str]]	No description.
label	str	No description.
max_length	typing.Union[int, float]	No description.
max_value	typing.Union[int, float]	No description.
min_length	typing.Union[int, float]	No description.
min_value	typing.Union[int, float]	No description.
no_echo	bool	No description.
text_area	bool	No description.
type	RosParameterType	No description.

---

scope^Required

• Type: Construct

---

id^Required

• Type: str

---

allowed_pattern^Optional

• Type: str

---

allowed_values^Optional

• Type: typing.List[typing.Any]

---

association_property^Optional

• Type: str

---

association_property_metadata^Optional

• Type: typing.Mapping[typing.Any]

---

confirm^Optional

• Type: bool

---

constraint_description^Optional

• Type: typing.Union[str, typing.Mapping[str]]

---

default_value^Optional

• Type: typing.Any

---

description^Optional

• Type: typing.Union[str, typing.Mapping[str]]

---

label^Optional

• Type: str

---

max_length^Optional

• Type: typing.Union[int, float]

---

max_value^Optional

• Type: typing.Union[int, float]

---

min_length^Optional

• Type: typing.Union[int, float]

---

min_value^Optional

• Type: typing.Union[int, float]

---

no_echo^Optional

• Type: bool

---

text_area^Optional

• Type: bool

---

type^Optional

• Type: RosParameterType

---

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.
resolve	No description.
validate_properties	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.

---

resolve

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

_context^Required

• Type: IResolveContext

---

validate_properties

def validate_properties(
  allowed_pattern: str = None,
  allowed_values: typing.List[typing.Any] = None,
  association_property: str = None,
  association_property_metadata: typing.Mapping[typing.Any] = None,
  confirm: bool = None,
  constraint_description: typing.Union[str, typing.Mapping[str]] = None,
  default_value: typing.Any = None,
  description: typing.Union[str, typing.Mapping[str]] = None,
  label: str = None,
  max_length: typing.Union[int, float] = None,
  max_value: typing.Union[int, float] = None,
  min_length: typing.Union[int, float] = None,
  min_value: typing.Union[int, float] = None,
  no_echo: bool = None,
  text_area: bool = None,
  type: RosParameterType = None
) -> None

allowed_pattern^Optional

• Type: str

---

allowed_values^Optional

• Type: typing.List[typing.Any]

---

association_property^Optional

• Type: str

---

association_property_metadata^Optional

• Type: typing.Mapping[typing.Any]

---

confirm^Optional

• Type: bool

---

constraint_description^Optional

• Type: typing.Union[str, typing.Mapping[str]]

---

default_value^Optional

• Type: typing.Any

---

description^Optional

• Type: typing.Union[str, typing.Mapping[str]]

---

label^Optional

• Type: str

---

max_length^Optional

• Type: typing.Union[int, float]

---

max_value^Optional

• Type: typing.Union[int, float]

---

min_length^Optional

• Type: typing.Union[int, float]

---

min_value^Optional

• Type: typing.Union[int, float]

---

no_echo^Optional

• Type: bool

---

text_area^Optional

• Type: bool

---

type^Optional

• Type: RosParameterType

---

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.RosParameter.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.RosParameter.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.
no_echo	bool	Indicates if this parameter is configured with "NoEcho" enabled.
value	IResolvable	The parameter value as a Token.
value_as_any	typing.Any	The parameter value, if it represents a string.
value_as_boolean	typing.Any	The parameter value, if it represents a string.
value_as_list	typing.List[str]	The parameter value, if it represents a string list.
value_as_number	typing.Union[int, float]	The parameter value, if it represents a number.
value_as_string	str	The parameter value, if it represents a string.

---

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

---

no_echo^Required

no_echo: bool

• Type: bool

Indicates if this parameter is configured with "NoEcho" enabled.

---

value^Required

value: IResolvable

• Type: IResolvable

The parameter value as a Token.

---

value_as_any^Required

value_as_any: typing.Any

• Type: typing.Any

The parameter value, if it represents a string.

---

value_as_boolean^Required

value_as_boolean: typing.Any

• Type: typing.Any

The parameter value, if it represents a string.

---

value_as_list^Required

value_as_list: typing.List[str]

• Type: typing.List[str]

The parameter value, if it represents a string list.

---

value_as_number^Required

value_as_number: typing.Union[int, float]

• Type: typing.Union[int, float]

The parameter value, if it represents a number.

---

value_as_string^Required

value_as_string: str

• Type: str

The parameter value, if it represents a string.

---

Constants

Name	Type	Description
TYPE_ALLOWED_VALUES	typing.List[str]	No description.

---

TYPE_ALLOWED_VALUES^Required

TYPE_ALLOWED_VALUES: typing.List[str]

• Type: typing.List[str]

---