ScalingGroupProps

Properties for defining a ScalingGroup.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkess"
&alicloudroscdkess.ScalingGroupProps {
    MaxSize: interface{},
    MinSize: interface{},
    AllocationStrategy: interface{},
    AzBalance: interface{},
    CompensateWithOnDemand: interface{},
    ContainerGroupId: interface{},
    CustomPolicyArn: interface{},
    DbInstanceIds: interface{},
    DefaultCooldown: interface{},
    DesiredCapacity: interface{},
    GroupDeletionProtection: interface{},
    GroupType: interface{},
    HealthCheckType: interface{},
    InstanceId: interface{},
    LaunchTemplateId: interface{},
    LaunchTemplateOverrides: interface{},
    LaunchTemplateVersion: interface{},
    LoadBalancerIds: interface{},
    MaxInstanceLifetime: interface{},
    MultiAzPolicy: interface{},
    NotificationConfigurations: interface{},
    OnDemandBaseCapacity: interface{},
    OnDemandPercentageAboveBaseCapacity: interface{},
    ProtectedInstances: interface{},
    RemovalPolicys: interface{},
    ResourceGroupId: interface{},
    ScalingGroupName: interface{},
    ScalingPolicy: interface{},
    ServerGroups: interface{},
    SpotAllocationStrategy: interface{},
    SpotInstancePools: interface{},
    SpotInstanceRemedy: interface{},
    StandbyInstances: interface{},
    Tags: *[]github.com/alibabacloud-go/ros-cdk/alicloudroscdkess.RosScalingGroup.TagsProperty,
    VSwitchId: interface{},
    VSwitchIds: interface{},
}

Properties

Name	Type	Description
MaxSize	interface{}	Property maxSize: Maximum number of ECS instances in the scaling group.
MinSize	interface{}	Property minSize: Minimum number of ECS instances in the scaling group.
AllocationStrategy	interface{}	Property allocationStrategy: The allocation policy of instances.
AzBalance	interface{}	Property azBalance: Specifies whether to evenly distribute instances in the scaling group across multiple zones.
CompensateWithOnDemand	interface{}	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	interface{}	Property containerGroupId: The ID of the elastic container instance.
CustomPolicyArn	interface{}	Property customPolicyArn: The Alibaba Cloud Resource Name (ARN) of the custom scale-in policy (Function).
DbInstanceIds	interface{}	Property dbInstanceIds: ID list of an RDS instance.
DefaultCooldown	interface{}	Property defaultCooldown: Default cool-down time (in seconds) of the scaling group.
DesiredCapacity	interface{}	Property desiredCapacity: The expected number of ECS instances in a scaling group.
GroupDeletionProtection	interface{}	Property groupDeletionProtection: Whether to enable deletion protection for scaling group.
GroupType	interface{}	Property groupType: The type of instances that are managed by the scaling group.
HealthCheckType	interface{}	Property healthCheckType: The health check type.
InstanceId	interface{}	Property instanceId: The ID of the ECS instance from which the scaling group obtains configuration information of the specified instance.
LaunchTemplateId	interface{}	Property launchTemplateId: The ID of the instance launch template from which the scaling group obtains launch configurations.
LaunchTemplateOverrides	interface{}	Property launchTemplateOverrides: You can specify up to 10 overrides.
LaunchTemplateVersion	interface{}	Property launchTemplateVersion: The version of the instance launch template.
LoadBalancerIds	interface{}	Property loadBalancerIds: ID list of a Server Load Balancer instance.
MaxInstanceLifetime	interface{}	Property maxInstanceLifetime: The maximum life span of an ECS instance in the scaling group.
MultiAzPolicy	interface{}	Property multiAzPolicy: ECS scaling strategy for multi availability zone.
NotificationConfigurations	interface{}	Property notificationConfigurations: When a scaling event occurs in a scaling group, ESS will send a notification to Cloud Monitor or MNS.
OnDemandBaseCapacity	interface{}	Property onDemandBaseCapacity: The minimum number of pay-as-you-go instances required in the scaling group.
OnDemandPercentageAboveBaseCapacity	interface{}	Property onDemandPercentageAboveBaseCapacity: The percentage of pay-as-you-go instances that can be created when instances are added to the scaling group.
ProtectedInstances	interface{}	Property protectedInstances: ECS instances of protected mode in the scaling group.
RemovalPolicys	interface{}	Property removalPolicys: Policy for removing ECS instances from the scaling group.
ResourceGroupId	interface{}	Property resourceGroupId: Resource group id.
ScalingGroupName	interface{}	Property scalingGroupName: Name shown for the scaling group, which must contain 2-40 characters (English or Chinese).
ScalingPolicy	interface{}	Property scalingPolicy: The reclaim mode of the scaling group.
ServerGroups	interface{}	Property serverGroups: The config of server group.
SpotAllocationStrategy	interface{}	Property spotAllocationStrategy: The allocation policy of preemptible instances.
SpotInstancePools	interface{}	Property spotInstancePools: The number of instance types that are available.
SpotInstanceRemedy	interface{}	Property spotInstanceRemedy: Specifies whether to supplement preemptible instances.
StandbyInstances	interface{}	Property standbyInstances: ECS instances of standby mode in the scaling group.
Tags	*[]TagsProperty	Property tags: Tags to attach to instance.
VSwitchId	interface{}	Property vSwitchId: If you create a VPC scaling group, you must specify the ID of a VSwitch.
VSwitchIds	interface{}	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.

---

MaxSize^Required

MaxSize interface{}

• Type: interface{}

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

Value range: [0, 2000].

---

MinSize^Required

MinSize interface{}

• Type: interface{}

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

Value range: [0, 2000].

---

AllocationStrategy^Optional

AllocationStrategy interface{}

• Type: interface{}

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.

---

AzBalance^Optional

AzBalance interface{}

• Type: interface{}

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.

---

CompensateWithOnDemand^Optional

CompensateWithOnDemand interface{}

• Type: interface{}

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.

---

ContainerGroupId^Optional

ContainerGroupId interface{}

• Type: interface{}

Property containerGroupId: The ID of the elastic container instance.

---

CustomPolicyArn^Optional

CustomPolicyArn interface{}

• Type: interface{}

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.

---

DbInstanceIds^Optional

DbInstanceIds interface{}

• Type: interface{}

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.

---

DefaultCooldown^Optional

DefaultCooldown interface{}

• Type: interface{}

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

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

---

DesiredCapacity^Optional

DesiredCapacity interface{}

• Type: interface{}

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.

---

GroupDeletionProtection^Optional

GroupDeletionProtection interface{}

• Type: interface{}

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

Default to False.

---

GroupType^Optional

GroupType interface{}

• Type: interface{}

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

Valid values: ECS ECI Default value: ECS.

---

HealthCheckType^Optional

HealthCheckType interface{}

• Type: interface{}

Property healthCheckType: The health check type.

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

---

InstanceId^Optional

InstanceId interface{}

• Type: interface{}

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

---

LaunchTemplateId^Optional

LaunchTemplateId interface{}

• Type: interface{}

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

---

LaunchTemplateOverrides^Optional

LaunchTemplateOverrides interface{}

• Type: interface{}

Property launchTemplateOverrides: You can specify up to 10 overrides.

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

---

LaunchTemplateVersion^Optional

LaunchTemplateVersion interface{}

• Type: interface{}

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.

---

LoadBalancerIds^Optional

LoadBalancerIds interface{}

• Type: interface{}

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.

---

MaxInstanceLifetime^Optional

MaxInstanceLifetime interface{}

• Type: interface{}

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.

---

MultiAzPolicy^Optional

MultiAzPolicy interface{}

• Type: interface{}

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.

---

NotificationConfigurations^Optional

NotificationConfigurations interface{}

• Type: interface{}

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

---

OnDemandBaseCapacity^Optional

OnDemandBaseCapacity interface{}

• Type: interface{}

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.

---

OnDemandPercentageAboveBaseCapacity^Optional

OnDemandPercentageAboveBaseCapacity interface{}

• Type: interface{}

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.

---

ProtectedInstances^Optional

ProtectedInstances interface{}

• Type: interface{}

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

---

RemovalPolicys^Optional

RemovalPolicys interface{}

• Type: interface{}

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.

---

ResourceGroupId^Optional

ResourceGroupId interface{}

• Type: interface{}

Property resourceGroupId: Resource group id.

---

ScalingGroupName^Optional

ScalingGroupName interface{}

• Type: interface{}

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.

---

ScalingPolicy^Optional

ScalingPolicy interface{}

• Type: interface{}

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.

---

ServerGroups^Optional

ServerGroups interface{}

• Type: interface{}

Property serverGroups: The config of server group.

---

SpotAllocationStrategy^Optional

SpotAllocationStrategy interface{}

• Type: interface{}

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.

---

SpotInstancePools^Optional

SpotInstancePools interface{}

• Type: interface{}

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.

---

SpotInstanceRemedy^Optional

SpotInstanceRemedy interface{}

• Type: interface{}

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.

---

StandbyInstances^Optional

StandbyInstances interface{}

• Type: interface{}

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

---

Tags^Optional

Tags *[]TagsProperty

• Type: *[]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.

---

VSwitchId^Optional

VSwitchId interface{}

• Type: interface{}

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

---

VSwitchIds^Optional

VSwitchIds interface{}

• Type: interface{}

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.

---