Stack

This class encapsulates and extends the ROS resource type ALIYUN::ROS::Stack, which is used to create a nested stack.

You can nest stacks up to five levels of depth.

Initializers

import ros_cdk_ros
ros_cdk_ros.Stack(
  scope: Construct,
  id: str,
  parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  tags: typing.List[TagsProperty] = None,
  template_body: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  template_id: typing.Union[str, IResolvable] = None,
  template_url: typing.Union[str, IResolvable] = None,
  template_version: typing.Union[str, IResolvable] = None,
  timeout_mins: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
parameters	typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]	Property parameters: The set of parameters passed to this nested stack.
resource_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property resourceGroupId: Resource group.
tags	typing.List[TagsProperty]	Property tags: The tags of nested stack.
template_body	typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]	Property templateBody: Structure containing the template body.
template_id	typing.Union[str, ros_cdk_core.IResolvable]	Property templateId: Template ID of template containing the template body.
template_url	typing.Union[str, ros_cdk_core.IResolvable]	Property templateUrl: Location of file containing the template body.
template_version	typing.Union[str, ros_cdk_core.IResolvable]	Property templateVersion: Template version of template containing the template body.
timeout_mins	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property timeoutMins: The length of time, in minutes, to wait for the nested stack creation or update.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

parameters^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property parameters: The set of parameters passed to this nested stack.

---

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: Resource group.

---

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: The tags of nested stack.

If it is specified, it will be passed to all tag-supported resources in the nested stack.

---

template_body^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]]

Property templateBody: Structure containing the template body.

It is just to facilitate the passing of template. It is raw content.Functions in TemplateBody will not be resolved in parent stack. You must specify either the TemplateBody or the TemplateURL property. If both are specified, TemplateBody will be used.

---

template_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateId: Template ID of template containing the template body.

---

template_url^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateUrl: Location of file containing the template body.

The URL must point to a template (max size: 524288 bytes) that is located in a http web server(http, https), or an Aliyun OSS bucket(Such as oss://ros-template/demo?RegionId=cn-hangzhou, oss://ros-template/demo. RegionId is default to the value of RegionId Parameter of the request.). You must specify either the TemplateBody or the TemplateURL property. If both are specified, TemplateBody will be used.

---

template_version^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property templateVersion: Template version of template containing the template body.

---

timeout_mins^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property timeoutMins: The length of time, in minutes, to wait for the nested stack creation or update.

Default to 60 minutes.

---

enable_resource_property_constraint^Optional

• Type: bool

---

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.
add_condition	No description.
add_count	No description.
add_dependency	No description.
add_resource_desc	No description.
apply_removal_policy	No description.
get_att	No description.
set_metadata	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: ros_cdk_core.ISynthesisSession

The synthesis session.

---

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

---

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

---

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

---

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

---

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

---

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

---

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

---

value^Required

• Type: typing.Any

---

Static Functions

Name	Description
is_construct	Return whether the given object is a Construct.

---

is_construct

import ros_cdk_ros
ros_cdk_ros.Stack.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

---

Properties

Name	Type	Description
node	ros_cdk_core.ConstructNode	The construct tree node associated with this construct.
ref	str	No description.
stack	ros_cdk_core.Stack	The stack in which this resource is defined.
resource	ros_cdk_core.RosResource	No description.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

ref: str

• Type: str

---

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

---

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

---