Skip to content

ScalingGroupProps

Properties for defining a ScalingGroup.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-ess-scalinggroup

Initializer 

import com.aliyun.ros.cdk.ess.ScalingGroupProps;
ScalingGroupProps.builder()
    .maxSize(java.lang.Number)
    .maxSize(IResolvable)
    .minSize(java.lang.Number)
    .minSize(IResolvable)
//  .allocationStrategy(java.lang.String)
//  .allocationStrategy(IResolvable)
//  .azBalance(java.lang.Boolean)
//  .azBalance(IResolvable)
//  .compensateWithOnDemand(java.lang.Boolean)
//  .compensateWithOnDemand(IResolvable)
//  .containerGroupId(java.lang.String)
//  .containerGroupId(IResolvable)
//  .customPolicyArn(java.lang.String)
//  .customPolicyArn(IResolvable)
//  .dbInstanceIds(IResolvable)
//  .dbInstanceIds(java.util.List<java.lang.String)
//  .dbInstanceIds(IResolvable>)
//  .defaultCooldown(java.lang.Number)
//  .defaultCooldown(IResolvable)
//  .desiredCapacity(java.lang.Number)
//  .desiredCapacity(IResolvable)
//  .groupDeletionProtection(java.lang.Boolean)
//  .groupDeletionProtection(IResolvable)
//  .groupType(java.lang.String)
//  .groupType(IResolvable)
//  .healthCheckType(java.lang.String)
//  .healthCheckType(IResolvable)
//  .instanceId(java.lang.String)
//  .instanceId(IResolvable)
//  .launchTemplateId(java.lang.String)
//  .launchTemplateId(IResolvable)
//  .launchTemplateOverrides(IResolvable)
//  .launchTemplateOverrides(java.util.List<IResolvable)
//  .launchTemplateOverrides(LaunchTemplateOverridesProperty>)
//  .launchTemplateVersion(java.lang.String)
//  .launchTemplateVersion(IResolvable)
//  .loadBalancerIds(IResolvable)
//  .loadBalancerIds(java.util.List<java.lang.String)
//  .loadBalancerIds(IResolvable>)
//  .maxInstanceLifetime(java.lang.Number)
//  .maxInstanceLifetime(IResolvable)
//  .multiAzPolicy(java.lang.String)
//  .multiAzPolicy(IResolvable)
//  .notificationConfigurations(IResolvable)
//  .notificationConfigurations(java.util.List<IResolvable)
//  .notificationConfigurations(NotificationConfigurationsProperty>)
//  .onDemandBaseCapacity(java.lang.Number)
//  .onDemandBaseCapacity(IResolvable)
//  .onDemandPercentageAboveBaseCapacity(java.lang.Number)
//  .onDemandPercentageAboveBaseCapacity(IResolvable)
//  .protectedInstances(IResolvable)
//  .protectedInstances(java.util.List<java.lang.String)
//  .protectedInstances(IResolvable>)
//  .removalPolicys(IResolvable)
//  .removalPolicys(java.util.List<java.lang.String)
//  .removalPolicys(IResolvable>)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
//  .scalingGroupName(java.lang.String)
//  .scalingGroupName(IResolvable)
//  .scalingPolicy(java.lang.String)
//  .scalingPolicy(IResolvable)
//  .serverGroups(IResolvable)
//  .serverGroups(java.util.List<IResolvable)
//  .serverGroups(ServerGroupsProperty>)
//  .spotAllocationStrategy(java.lang.String)
//  .spotAllocationStrategy(IResolvable)
//  .spotInstancePools(java.lang.Number)
//  .spotInstancePools(IResolvable)
//  .spotInstanceRemedy(java.lang.Boolean)
//  .spotInstanceRemedy(IResolvable)
//  .standbyInstances(IResolvable)
//  .standbyInstances(java.util.List<java.lang.String)
//  .standbyInstances(IResolvable>)
//  .tags(java.util.List<TagsProperty>)
//  .vSwitchId(java.lang.String)
//  .vSwitchId(IResolvable)
//  .vSwitchIds(IResolvable)
//  .vSwitchIds(java.util.List<java.lang.String)
//  .vSwitchIds(IResolvable>)
    .build();

Properties

Name Type Description
maxSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxSize: Maximum number of ECS instances in the scaling group.
minSize java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property minSize: Minimum number of ECS instances in the scaling group.
allocationStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property allocationStrategy: The allocation policy of instances.
azBalance java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property azBalance: Specifies whether to evenly distribute instances in the scaling group across multiple zones.
compensateWithOnDemand java.lang.Boolean OR com.aliyun.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.
containerGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property containerGroupId: The ID of the elastic container instance.
customPolicyArn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property customPolicyArn: The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function).
dbInstanceIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property dbInstanceIds: ID list of an RDS instance.
defaultCooldown java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property defaultCooldown: Default cool-down time (in seconds) of the scaling group.
desiredCapacity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property desiredCapacity: The expected number of ECS instances in a scaling group.
groupDeletionProtection java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property groupDeletionProtection: Whether to enable deletion protection for scaling group.
groupType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property groupType: The type of instances that are managed by the scaling group.
healthCheckType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckType: The health check type.
instanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property instanceId: The ID of the ECS instance from which the scaling group obtains configuration information of the specified instance.
launchTemplateId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateId: The ID of the instance launch template from which the scaling group obtains launch configurations.
launchTemplateOverrides com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLaunchTemplateOverridesProperty> Property launchTemplateOverrides: You can specify up to 10 overrides.
launchTemplateVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property launchTemplateVersion: The version of the instance launch template.
loadBalancerIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property loadBalancerIds: ID list of a Server Load Balancer instance.
maxInstanceLifetime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property maxInstanceLifetime: The maximum life span of an ECS instance in the scaling group.
multiAzPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property multiAzPolicy: ECS scaling strategy for multi availability zone.
notificationConfigurations com.aliyun.ros.cdk.core.IResolvable OR java.util.ListNotificationConfigurationsProperty> Property notificationConfigurations: When a scaling event occurs in a scaling group, ESS will send a notification to Cloud Monitor or MNS.
onDemandBaseCapacity java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property onDemandBaseCapacity: The minimum number of pay-as-you-go instances required in the scaling group.
onDemandPercentageAboveBaseCapacity java.lang.Number OR com.aliyun.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.
protectedInstances com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property protectedInstances: ECS instances of protected mode in the scaling group.
removalPolicys com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property removalPolicys: Policy for removing ECS instances from the scaling group.
resourceGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property resourceGroupId: Resource group id.
scalingGroupName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scalingGroupName: Name shown for the scaling group, which must contain 2-40 characters (English or Chinese).
scalingPolicy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property scalingPolicy: The reclaim mode of the scaling group.
serverGroups com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServerGroupsProperty> Property serverGroups: The config of server group.
spotAllocationStrategy java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property spotAllocationStrategy: The allocation policy of preemptible instances.
spotInstancePools java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property spotInstancePools: The number of instance types that are available.
spotInstanceRemedy java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property spotInstanceRemedy: Specifies whether to supplement preemptible instances.
standbyInstances com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property standbyInstances: ECS instances of standby mode in the scaling group.
tags java.util.List<TagsProperty> Property tags: Tags to attach to instance.
vSwitchId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vSwitchId: If you create a VPC scaling group, you must specify the ID of a VSwitch.
vSwitchIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property vSwitchIds: Parameter VSwitchIds.N is used to create instance in multiple zones. Parameter VSwitchIds.N has a priority over parameter VSwitchId. The valid range of N is [1, 8], and you can specify at most 5 VSwitches in a VPC. The priority of VSwitches descends from 1 to 8, and 1 indicates the highest priority. When you fail to create an instance in the zone to which a specified VSwitch belongs, another VSwitch with less priority replaces the specified one automatically.

maxSizeRequired 

public java.lang.Object getMaxSize();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxSize: Maximum number of ECS instances in the scaling group.

Value range: [0, 2000].

minSizeRequired 

public java.lang.Object getMinSize();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

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

Value range: [0, 2000].

allocationStrategyOptional 

public java.lang.Object getAllocationStrategy();
  • Type: java.lang.String OR com.aliyun.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.

azBalanceOptional 

public java.lang.Object getAzBalance();
  • Type: java.lang.Boolean OR com.aliyun.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.

compensateWithOnDemandOptional 

public java.lang.Object getCompensateWithOnDemand();
  • Type: java.lang.Boolean OR com.aliyun.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.

containerGroupIdOptional 

public java.lang.Object getContainerGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property containerGroupId: The ID of the elastic container instance.

customPolicyArnOptional 

public java.lang.Object getCustomPolicyArn();
  • Type: java.lang.String OR com.aliyun.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.

dbInstanceIdsOptional 

public java.lang.Object getDbInstanceIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property dbInstanceIds: ID list of an RDS instance.

A Json Array with format: [ "rm-id0", "rm-id1", ... "rm-idz" ], support up to 100 RDS instance.

defaultCooldownOptional 

public java.lang.Object getDefaultCooldown();
  • Type: java.lang.Number OR com.aliyun.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.

desiredCapacityOptional 

public java.lang.Object getDesiredCapacity();
  • Type: java.lang.Number OR com.aliyun.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.

groupDeletionProtectionOptional 

public java.lang.Object getGroupDeletionProtection();
  • Type: java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable

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

Default to False.

groupTypeOptional 

public java.lang.Object getGroupType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: ECS ECI Default value: ECS.

healthCheckTypeOptional 

public java.lang.Object getHealthCheckType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property healthCheckType: The health check type.

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

instanceIdOptional 

public java.lang.Object getInstanceId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

launchTemplateIdOptional 

public java.lang.Object getLaunchTemplateId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

launchTemplateOverridesOptional 

public java.lang.Object getLaunchTemplateOverrides();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListLaunchTemplateOverridesProperty>

Property launchTemplateOverrides: You can specify up to 10 overrides.

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

launchTemplateVersionOptional 

public java.lang.Object getLaunchTemplateVersion();
  • Type: java.lang.String OR com.aliyun.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.

loadBalancerIdsOptional 

public java.lang.Object getLoadBalancerIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property loadBalancerIds: ID list of a Server Load Balancer instance.

A Json Array with format: [ "lb-id0", "lb-id1", ... "lb-idz" ], support up to 100 Load Balancer instance.

maxInstanceLifetimeOptional 

public java.lang.Object getMaxInstanceLifetime();
  • Type: java.lang.Number OR com.aliyun.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.

multiAzPolicyOptional 

public java.lang.Object getMultiAzPolicy();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property multiAzPolicy: ECS scaling strategy for multi availability zone.

Allow value:

  1. PRIORITY: scaling the capacity according to the virtual switch (VSwitchIds.N) you define. ECS instances are automatically created using the next priority virtual switch when the higher priority virtual switch cannot be created in the available zone.
  2. BALANCE: evenly allocate ECS instances between the multiple available zone specified by the scaling group.
  3. COST_OPTIMIZED: During a scale-out activity, Auto Scaling attempts to create ECS instances that have vCPUs provided at the lowest price. During a scale-in activity, Auto Scaling attempts to remove ECS instances that have vCPUs provided at the highest price. Preemptible instances are preferentially created when preemptible instance types are specified in the active scaling configuration. You can configure 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 COST_OPTIMIZED is valid when multiple instance types are specified or at least one preemptible instance type is specified.
  4. COMPOSABLE: You can flexibly combine the preceding policies based on your business requirements.

notificationConfigurationsOptional 

public java.lang.Object getNotificationConfigurations();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListNotificationConfigurationsProperty>

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

onDemandBaseCapacityOptional 

public java.lang.Object getOnDemandBaseCapacity();
  • Type: java.lang.Number OR com.aliyun.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.

onDemandPercentageAboveBaseCapacityOptional 

public java.lang.Object getOnDemandPercentageAboveBaseCapacity();
  • Type: java.lang.Number OR com.aliyun.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.

protectedInstancesOptional 

public java.lang.Object getProtectedInstances();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

removalPolicysOptional 

public java.lang.Object getRemovalPolicys();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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.

resourceGroupIdOptional 

public java.lang.Object getResourceGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: Resource group id.

scalingGroupNameOptional 

public java.lang.Object getScalingGroupName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property scalingGroupName: Name shown for the scaling group, which must contain 2-40 characters (English or Chinese).

The name must begin with a number, an upper/lower-case letter or a Chinese character and may contain numbers, "_", "-" or ".". The account name is unique in the same region. If this parameter is not specified, the default value is ScalingGroupId.

scalingPolicyOptional 

public java.lang.Object getScalingPolicy();
  • Type: java.lang.String OR com.aliyun.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.

serverGroupsOptional 

public java.lang.Object getServerGroups();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListServerGroupsProperty>

Property serverGroups: The config of server group.

spotAllocationStrategyOptional 

public java.lang.Object getSpotAllocationStrategy();
  • Type: java.lang.String OR com.aliyun.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.

spotInstancePoolsOptional 

public java.lang.Object getSpotInstancePools();
  • Type: java.lang.Number OR com.aliyun.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.

spotInstanceRemedyOptional 

public java.lang.Object getSpotInstanceRemedy();
  • Type: java.lang.Boolean OR com.aliyun.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.

standbyInstancesOptional 

public java.lang.Object getStandbyInstances();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

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

tagsOptional 

public java.util.List<TagsProperty> getTags();

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.

vSwitchIdOptional 

public java.lang.Object getVSwitchId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vSwitchId: If you create a VPC scaling group, you must specify the ID of a VSwitch.

vSwitchIdsOptional 

public java.lang.Object getVSwitchIds();
  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property vSwitchIds: Parameter VSwitchIds.N is used to create instance in multiple zones. Parameter VSwitchIds.N has a priority over parameter VSwitchId. The valid range of N is [1, 8], and you can specify at most 5 VSwitches in a VPC. The priority of VSwitches descends from 1 to 8, and 1 indicates the highest priority. When you fail to create an instance in the zone to which a specified VSwitch belongs, another VSwitch with less priority replaces the specified one automatically.