Skip to content

StackGroup

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

Initializers

import ros_cdk_ros
ros_cdk_ros.StackGroup(
  scope: Construct,
  id: str,
  stack_group_name: typing.Union[str, IResolvable],
  administration_role_name: typing.Union[str, IResolvable] = None,
  auto_deployment: typing.Union[IResolvable, AutoDeploymentProperty] = None,
  description: typing.Union[str, IResolvable] = None,
  dynamic_template_body: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  execution_role_name: typing.Union[str, IResolvable] = None,
  parameters: typing.Union[IResolvable, typing.Mapping[typing.Any]] = None,
  permission_model: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = 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,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
stack_group_name typing.Union[str, ros_cdk_core.IResolvable] Property stackGroupName: undefined.
administration_role_name typing.Union[str, ros_cdk_core.IResolvable] Property administrationRoleName: undefined.
auto_deployment typing.Union[ros_cdk_core.IResolvable, AutoDeploymentProperty] Property autoDeployment: undefined.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: undefined.
dynamic_template_body typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property dynamicTemplateBody: undefined.
execution_role_name typing.Union[str, ros_cdk_core.IResolvable] Property executionRoleName: undefined.
parameters typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property parameters: undefined.
permission_model typing.Union[str, ros_cdk_core.IResolvable] Property permissionModel: undefined.
resource_group_id typing.Union[str, ros_cdk_core.IResolvable] Property resourceGroupId: undefined.
template_body typing.Union[ros_cdk_core.IResolvable, typing.Mapping[typing.Any]] Property templateBody: undefined.
template_id typing.Union[str, ros_cdk_core.IResolvable] Property templateId: undefined.
template_url typing.Union[str, ros_cdk_core.IResolvable] Property templateUrl: undefined.
template_version typing.Union[str, ros_cdk_core.IResolvable] Property templateVersion: undefined.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

stack_group_nameRequired

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

Property stackGroupName: undefined.


administration_role_nameOptional

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

Property administrationRoleName: undefined.


auto_deploymentOptional

Property autoDeployment: undefined.


descriptionOptional

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

Property description: undefined.


dynamic_template_bodyOptional

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

Property dynamicTemplateBody: undefined.


execution_role_nameOptional

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

Property executionRoleName: undefined.


parametersOptional

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

Property parameters: undefined.


permission_modelOptional

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

Property permissionModel: undefined.


resource_group_idOptional

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

Property resourceGroupId: undefined.


template_bodyOptional

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

Property templateBody: undefined.


template_idOptional

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

Property templateId: undefined.


template_urlOptional

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

Property templateUrl: undefined.


template_versionOptional

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

Property templateVersion: undefined.


enable_resource_property_constraintOptional

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

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.


add_condition

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count

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

countRequired

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata

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

keyRequired

  • Type: str

valueRequired

  • 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.StackGroup.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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.
attr_stack_group_id ros_cdk_core.IResolvable Attribute StackGroupId: undefined.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.


refRequired

ref: str
  • Type: str

stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


resourceOptional

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_stack_group_idRequired

attr_stack_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute StackGroupId: undefined.