ScalingGroupEnable

This class encapsulates and extends the ROS resource type ALIYUN::ESS::ScalingGroupEnable, which is used to enable a scaling group.

Initializers

import ros_cdk_ess
ros_cdk_ess.ScalingGroupEnable(
  scope: Construct,
  id: str,
  scaling_group_id: typing.Union[str, IResolvable],
  attach_options: typing.Union[IResolvable, AttachOptionsProperty] = None,
  detach_options: typing.Union[IResolvable, DetachOptionsProperty] = None,
  instance_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  remove_instance_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  scaling_configuration_id: typing.Union[str, IResolvable] = None,
  scaling_rule_aris: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  scaling_rule_aris_execute_version: 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.
scaling_group_id	typing.Union[str, ros_cdk_core.IResolvable]	Property scalingGroupId: The id of operated scaling group.
attach_options	typing.Union[ros_cdk_core.IResolvable, AttachOptionsProperty]	Property attachOptions: Options for attaching instances.
detach_options	typing.Union[ros_cdk_core.IResolvable, DetachOptionsProperty]	Property detachOptions: Options for detaching instances.
instance_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property instanceIds: The id list of ECS instance which will be attached.
remove_instance_ids	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property removeInstanceIds: The id list of ECS instance which will be removed.
scaling_configuration_id	typing.Union[str, ros_cdk_core.IResolvable]	Property scalingConfigurationId: The id of scaling configuration which will be activate.
scaling_rule_aris	typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]	Property scalingRuleAris: A list of scaling rule aris which will be executed.
scaling_rule_aris_execute_version	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property scalingRuleArisExecuteVersion: The change of the property leads to the execution of all the scaling rule aris in ScalingRuleAris.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

scaling_group_id^Required

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

Property scalingGroupId: The id of operated scaling group.

---

attach_options^Optional

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

Property attachOptions: Options for attaching instances.

---

detach_options^Optional

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

Property detachOptions: Options for detaching instances.

---

instance_ids^Optional

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

Property instanceIds: The id list of ECS instance which will be attached.

Max support 1000 instances.

---

remove_instance_ids^Optional

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

Property removeInstanceIds: The id list of ECS instance which will be removed.

Max support 1000 instances.

---

scaling_configuration_id^Optional

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

Property scalingConfigurationId: The id of scaling configuration which will be activate.

---

scaling_rule_aris^Optional

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

Property scalingRuleAris: A list of scaling rule aris which will be executed.

Max support 10 scaling rule aris. When creating the resource, all the scaling rule aris in the list will be executed. When updating the resource, none of scaling rule aris in the list will be executed, unless ScalingRuleArisExecuteVersion is changed.

---

scaling_rule_aris_execute_version^Optional

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

Property scalingRuleArisExecuteVersion: The change of the property leads to the execution of all the scaling rule aris in ScalingRuleAris.

---

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_ess
ros_cdk_ess.ScalingGroupEnable.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.
attr_lifecycle_state	ros_cdk_core.IResolvable	Attribute LifecycleState: The scaling group status.
attr_scaling_group_id	ros_cdk_core.IResolvable	Attribute ScalingGroupId: The scaling group id.
attr_scaling_instance_details	ros_cdk_core.IResolvable	Attribute ScalingInstanceDetails: Detail information of auto created scaling instances.
attr_scaling_instances	ros_cdk_core.IResolvable	Attribute ScalingInstances: The auto created scaling instances.
attr_scaling_rule_aris_execute_error_info	ros_cdk_core.IResolvable	Attribute ScalingRuleArisExecuteErrorInfo: The error info of the execution of scaling rule aris.
attr_scaling_rule_aris_execute_result_instances_added	ros_cdk_core.IResolvable	Attribute ScalingRuleArisExecuteResultInstancesAdded: Instances added via the execution of scaling rule aris.
attr_scaling_rule_aris_execute_result_instances_removed	ros_cdk_core.IResolvable	Attribute ScalingRuleArisExecuteResultInstancesRemoved: Instances removed via the execution of scaling rule aris.
attr_scaling_rule_aris_execute_result_number_of_added_instances	ros_cdk_core.IResolvable	Attribute ScalingRuleArisExecuteResultNumberOfAddedInstances: The number of added vm via the execution of scaling rule aris.

---

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

---

attr_lifecycle_state^Required

attr_lifecycle_state: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute LifecycleState: The scaling group status.

---

attr_scaling_group_id^Required

attr_scaling_group_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ScalingGroupId: The scaling group id.

---

attr_scaling_instance_details^Required

attr_scaling_instance_details: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ScalingInstanceDetails: Detail information of auto created scaling instances.

---

attr_scaling_instances^Required

attr_scaling_instances: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ScalingInstances: The auto created scaling instances.

---

attr_scaling_rule_aris_execute_error_info^Required

attr_scaling_rule_aris_execute_error_info: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ScalingRuleArisExecuteErrorInfo: The error info of the execution of scaling rule aris.

---

attr_scaling_rule_aris_execute_result_instances_added^Required

attr_scaling_rule_aris_execute_result_instances_added: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ScalingRuleArisExecuteResultInstancesAdded: Instances added via the execution of scaling rule aris.

---

attr_scaling_rule_aris_execute_result_instances_removed^Required

attr_scaling_rule_aris_execute_result_instances_removed: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ScalingRuleArisExecuteResultInstancesRemoved: Instances removed via the execution of scaling rule aris.

---

attr_scaling_rule_aris_execute_result_number_of_added_instances^Required

attr_scaling_rule_aris_execute_result_number_of_added_instances: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ScalingRuleArisExecuteResultNumberOfAddedInstances: The number of added vm via the execution of scaling rule aris.

---