ScalingGroupEnable

• Implements: IScalingGroupEnable

This class encapsulates and extends the ROS resource type ALIYUN::ESS::ScalingGroupEnable.

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
)

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

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

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

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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: typing.Union[str, IResolvable]

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

Attribute LifecycleState: The scaling group status.

attr_scaling_group_id^Required

attr_scaling_group_id: typing.Union[str, IResolvable]

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

Attribute ScalingGroupId: The scaling group id.

attr_scaling_instance_details^Required

attr_scaling_instance_details: typing.Union[str, IResolvable]

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

Attribute ScalingInstanceDetails: Detail information of auto created scaling instances.

attr_scaling_instances^Required

attr_scaling_instances: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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: typing.Union[str, IResolvable]

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

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

props^Required

props: ScalingGroupEnableProps

• Type: ScalingGroupEnableProps