ScalingGroup

• Implements: IScalingGroup

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

Initializers

import ros_cdk_ess
ros_cdk_ess.ScalingGroup(
  scope: Construct,
  id: str,
  max_size: typing.Union[typing.Union[int, float], IResolvable],
  min_size: typing.Union[typing.Union[int, float], IResolvable],
  allocation_strategy: typing.Union[str, IResolvable] = None,
  az_balance: typing.Union[bool, IResolvable] = None,
  compensate_with_on_demand: typing.Union[bool, IResolvable] = None,
  container_group_id: typing.Union[str, IResolvable] = None,
  custom_policy_arn: typing.Union[str, IResolvable] = None,
  db_instance_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  default_cooldown: typing.Union[typing.Union[int, float], IResolvable] = None,
  desired_capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
  group_deletion_protection: typing.Union[bool, IResolvable] = None,
  group_type: typing.Union[str, IResolvable] = None,
  health_check_type: typing.Union[str, IResolvable] = None,
  health_check_types: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  instance_id: typing.Union[str, IResolvable] = None,
  launch_template_id: typing.Union[str, IResolvable] = None,
  launch_template_overrides: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, LaunchTemplateOverridesProperty]]] = None,
  launch_template_version: typing.Union[str, IResolvable] = None,
  load_balancer_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  max_instance_lifetime: typing.Union[typing.Union[int, float], IResolvable] = None,
  multi_az_policy: typing.Union[str, IResolvable] = None,
  notification_configurations: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, NotificationConfigurationsProperty]]] = None,
  on_demand_base_capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
  on_demand_percentage_above_base_capacity: typing.Union[typing.Union[int, float], IResolvable] = None,
  protected_instances: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  removal_policys: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  scaling_group_name: typing.Union[str, IResolvable] = None,
  scaling_policy: typing.Union[str, IResolvable] = None,
  server_groups: typing.Union[IResolvable, typing.List[typing.Union[IResolvable, ServerGroupsProperty]]] = None,
  spot_allocation_strategy: typing.Union[str, IResolvable] = None,
  spot_instance_pools: typing.Union[typing.Union[int, float], IResolvable] = None,
  spot_instance_remedy: typing.Union[bool, IResolvable] = None,
  standby_instances: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  tags: typing.List[TagsProperty] = None,
  v_switch_id: typing.Union[str, IResolvable] = None,
  v_switch_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

max_size^Required

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

Property maxSize: The maximum number of ECS instances that can be contained in the scaling group.

If the number of ECS instances in the scaling group is greater than the value of the MaxSize parameter, Auto Scaling automatically removes ECS instances until the number of instances in the scaling group is equal to the maximum number. The value range of the MaxSize parameter varies based on the instance quota. You can go to Quota Center to check the maximum number of instances that a scaling group can contain. For example, if a scaling group can contain up to 2,000 instances, the value range of the MaxSize parameter is 0 to 2000.

min_size^Required

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

Property minSize: Minimum number of ECS instances in the scaling group.

Value range: [0, 2000].

allocation_strategy^Optional

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

Property allocationStrategy: The allocation policy of instances.

Auto Scaling selects instance types based on the allocation policy to create the required number of instances. The policy can be applied to pay-as-you-go instances and preemptible instances. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE. Valid values:

• priority: Auto Scaling selects instance types based on the specified order to create the required number of instances.
• lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of instances. Default value: priority.

az_balance^Optional

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

Property azBalance: Specifies whether to evenly distribute instances in the scaling group across multiple zones.

This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE. Valid values:

• true
• false Default value: false.

compensate_with_on_demand^Optional

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

Property compensateWithOnDemand: Specifies whether to automatically create pay-as-you-go instances to meet the requirements on the number of instances when the expected capacity of preemptible instances cannot be fulfilled due to reasons such as high prices or insufficient resources.

This parameter takes effect only when MultiAZPolicy is set to COST_OPTIMIZED. Default value: true.

container_group_id^Optional

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

Property containerGroupId: The ID of the elastic container instance.

custom_policy_arn^Optional

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

Property customPolicyArn: The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function).

This parameter takes effect only if you specify CustomPolicy as the value of first item of RemovalPolicys.

db_instance_ids^Optional

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

Property dbInstanceIds: The IDs of the ApsaraDB RDS instances that you want to associate with the scaling group.

The value can be a JSON array that contains multiple ApsaraDB RDS instance IDs. Separate multiple IDs with commas (,). You can associate only a limited number of ApsaraDB RDS instances with a scaling group. Go to Quota Center to check the maximum number of ApsaraDB RDS instances that you can associate with a scaling group.

default_cooldown^Optional

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

Property defaultCooldown: Default cool-down time (in seconds) of the scaling group.

Value range: [0, 86400]. The default value is 300s.

desired_capacity^Optional

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

Property desiredCapacity: The expected number of ECS instances in a scaling group.

The scaling group automatically keeps the number of ECS instances as expected. The number of ECS instances cannot be greater than the value of MaxSize and cannot be less than the value of MinSize.

group_deletion_protection^Optional

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

Property groupDeletionProtection: Whether to enable deletion protection for scaling group.

Default to False.

group_type^Optional

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

Property groupType: The type of instances that are managed by the scaling group.

Valid values: ECS ECI Default value: ECS.

health_check_type^Optional

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

Property healthCheckType: The health check type.

Allow values is "ECS" and "NONE", default to "ECS".

health_check_types^Optional

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

Property healthCheckTypes: The health check method for the scaling group.

You can specify multiple values for this parameter to enable multiple health check options. If the HealthCheckType parameter is set, this parameter is ignored.

instance_id^Optional

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

Property instanceId: The ID of the ECS instance from which the scaling group obtains configuration information of the specified instance.

launch_template_id^Optional

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

Property launchTemplateId: The ID of the instance launch template from which the scaling group obtains launch configurations.

launch_template_overrides^Optional

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

Property launchTemplateOverrides: You can specify up to 10 overrides.

Note: This parameter takes effect only if you specify LaunchTemplateId.

launch_template_version^Optional

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

Property launchTemplateVersion: The version of the instance launch template.

Valid values: A fixed template version numbe. Default: The default template version is always used. Latest: The latest template version is always used.

load_balancer_ids^Optional

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

Property loadBalancerIds: The IDs of the CLB instances that you want to associate with the scaling group.

The value can be a JSON array that contains multiple CLB instance IDs. Separate multiple IDs with commas (,). You can associate only a limited number of CLB instances with a scaling group. Go to Quota Center to check the maximum number of CLB instances that you can associate with a scaling group.

max_instance_lifetime^Optional

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

Property maxInstanceLifetime: The maximum life span of an ECS instance in the scaling group.

Unit: seconds. Valid values: 86400 to the value of Integer.maxValue. Default value: null. Note: This parameter is unavailable for scaling groups of the ECI type or scaling groups whose ScalingPolicy is set to recycle.

multi_az_policy^Optional

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

Property multiAzPolicy: The scaling policy for the multi-zone scaling group that contains ECS instances.

Valid values:

• PRIORITY: Auto Scaling scales ECS instances based on the priority of the vSwitch that is specified by the VSwitchIds.N parameter. Auto Scaling preferentially scales instances in the zone where the vSwitch that has the highest priority resides. If the scaling fails, Auto Scaling scales instances in the zone where the vSwitch that has the next highest priority resides.
• COST_OPTIMIZED: Auto Scaling preferentially creates ECS instances whose vCPUs are provided at the lowest price and removes ECS instances whose vCPUs are provided at the highest price. If preemptible instance types are specified in the scaling configuration, Auto Scaling preferentially creates preemptible instances. You can use the CompensateWithOnDemand parameter to specify whether to automatically create pay-as-you-go instances when preemptible instances cannot be created due to insufficient resources. Note The COST_OPTIMIZED **setting takes effect only when you specify multiple instance types or when you specify at least one preemptible instance type.
• BALANCE: Auto Scaling evenly distributes ECS instances across zones that are specified for the scaling group. If ECS instances are unevenly distributed across zones due to insufficient resources, you can call the RebalanceInstance operation to evenly distribute the instances across the zones.
• COMPOSABLE: You can combine the preceding policies based on your business requirements. Default value: PRIORITY.

notification_configurations^Optional

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

Property notificationConfigurations: When a scaling event occurs in a scaling group, ESS will send a notification to Cloud Monitor or MNS.

on_demand_base_capacity^Optional

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

Property onDemandBaseCapacity: The minimum number of pay-as-you-go instances required in the scaling group.

Valid values: 0 to 1000. If the number of pay-as-you-go instances is less than the value of this parameter, Auto Scaling preferentially creates pay-as-you-go instances. If you set MultiAZPolicy to COMPOSABLE Policy, the default value of this parameter is 0.

on_demand_percentage_above_base_capacity^Optional

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

Property onDemandPercentageAboveBaseCapacity: The percentage of pay-as-you-go instances that can be created when instances are added to the scaling group.

This parameter takes effect when the number of pay-as-you-go instances reaches the value for the OnDemandBaseCapacity parameter. Valid values: 0 to 100. If you set MultiAZPolicy to COMPOSABLE, the default value of this parameter is 100.

protected_instances^Optional

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

Property protectedInstances: ECS instances of protected mode in the scaling group.

removal_policys^Optional

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

Property removalPolicys: Policy for removing ECS instances from the scaling group.

Optional values:

• OldestInstance: removes the first ECS instance attached to the scaling group.
• NewestInstance: removes the first ECS instance attached to the scaling group.
• OldestScalingConfiguration: removes the ECS instance with the oldest scaling configuration.
• CustomPolicy: removes ECS instances based on the custom scale-in policy (Function). You can enter up to three removal policies. You cannot set any item of RemovalPolicys to the same value. The scaling configuration source specified by the OldestScalingConfiguration setting can be a scaling configuration or a launch template. You can specify CustomPolicy only as the value of first item of RemovalPolicys. If you set first item of RemovalPolicys to CustomPolicy, you must also specify CustomPolicyARN. Note: The removal of ECS instances from a scaling group is also affected by the value of MultiAZPolicy.

resource_group_id^Optional

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

Property resourceGroupId: Resource group id.

scaling_group_name^Optional

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

Property scalingGroupName: The name of the scaling group.

The name of each scaling group must be unique in a region. The name must be 2 to 64 characters in length, and can contain letters, digits, underscores (_), hyphens (-), and periods (.). The name must start with a letter or a digit. If you do not specify this parameter, the value of the ScalingGroupId parameter is used.

scaling_policy^Optional

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

Property scalingPolicy: The reclaim mode of the scaling group.

Valid values: recycle release forcerelease ScalingPolicy specifies the reclaim modes of scaling groups, but the policy that is used to remove ECS instances from scaling groups is determined by the RemovePolicy parameter of the RemoveInstances operation.

server_groups^Optional

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

Property serverGroups: The config of server group.

spot_allocation_strategy^Optional

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

Property spotAllocationStrategy: The allocation policy of preemptible instances.

You can use this parameter to individually specify the allocation policy of preemptible instances. This parameter takes effect only if you set MultiAZPolicy to COMPOSABLE. Valid values:

• priority: Auto Scaling selects instance types based on the specified order to create the required number of preemptible instances.
• lowestPrice: Auto Scaling selects instance types that have the lowest unit price of vCPUs to create the required number of preemptible instances. Default value: priority.

spot_instance_pools^Optional

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

Property spotInstancePools: The number of instance types that are available.

The system creates preemptible instances of multiple instance types that are available at the lowest cost in the scaling group. Valid values: 1 to 10. If you set MultiAZPolicy to COMPOSABLE, the default value of this parameter is 2.

spot_instance_remedy^Optional

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

Property spotInstanceRemedy: Specifies whether to supplement preemptible instances.

If this parameter is set to true, Auto Scaling attempts to create an instance to replace a preemptible instance when Auto Scaling receives a system message which indicates that the preemptible instance is to be reclaimed.

standby_instances^Optional

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

Property standbyInstances: ECS instances of standby mode in the scaling group.

tags^Optional

• Type: typing.List[TagsProperty]

Property tags: Tags to attach to instance.

Max support 20 tags to add during create instance. Each tag with two properties Key and Value, and Key is required.

v_switch_id^Optional

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

Property vSwitchId: The ID of the vSwitch.

If you specify the VSwitchId parameter, the network type of the scaling group is VPC.

v_switch_ids^Optional

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

Property vSwitchIds: The IDs of vSwitches.

If you specify the VSwitchIds.N parameter, the VSwitchId parameter is ignored. If you specify the VSwitchIds.N parameter, the network type of the scaling group is VPC. If you specify multiple vSwitches, take note of the following items:

• The vSwitches must belong to the same VPC.
• The vSwitches can belong to different zones.
• The vSwitches are sorted in ascending order of priority. The first vSwitch that is specified by the VSwitchIds.N parameter has the highest priority. If Auto Scaling fails to create ECS instances in the zone where the vSwitch that has the highest priority resides, Auto Scaling creates ECS instances in the zone where the vSwitch that has the next highest priority resides.

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.ScalingGroup.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_arn^Required

attr_arn: typing.Union[str, IResolvable]

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

Attribute Arn: The Alibaba Cloud Resource Name (ARN).

attr_scaling_group_id^Required

attr_scaling_group_id: typing.Union[str, IResolvable]

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

Attribute ScalingGroupId: Scaling group Id.

attr_scaling_group_name^Required

attr_scaling_group_name: typing.Union[str, IResolvable]

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

Attribute ScalingGroupName: Scaling group name.

props^Required

props: ScalingGroupProps

• Type: ScalingGroupProps