ModifyScalingGroupRequest.Builder (alibabacloud-ess20220222 1.0.18 API)

java.lang.Object
- com.aliyun.sdk.service.ess20220222.models.ModifyScalingGroupRequest.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<ModifyScalingGroupRequest,ModifyScalingGroupRequest.Builder>

封闭类:

ModifyScalingGroupRequest
```
public static final class ModifyScalingGroupRequest.Builder
extends Object
```

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`ModifyScalingGroupRequest.Builder`	`activeScalingConfigurationId(String activeScalingConfigurationId)` The ID of the active scaling configuration in the scaling group.
`ModifyScalingGroupRequest.Builder`	`allocationStrategy(String allocationStrategy)` The allocation policy.
`ModifyScalingGroupRequest.Builder`	`azBalance(Boolean azBalance)` Specifies whether to evenly distribute instances in the scaling group across zones.
`ModifyScalingGroupRequest`	`build()`
`ModifyScalingGroupRequest.Builder`	`compensateWithOnDemand(Boolean compensateWithOnDemand)` Specifies whether to automatically create pay-as-you-go instances to meet the requirements on the number of ECS instances in the scaling group when the number of preemptible instances cannot be reached due to reasons such as cost-related issues and insufficient resources.
`ModifyScalingGroupRequest.Builder`	`customPolicyARN(String customPolicyARN)` The ARN of the custom scaling policy (Function).
`ModifyScalingGroupRequest.Builder`	`defaultCooldown(Integer defaultCooldown)` The cooldown period of the scaling group.
`ModifyScalingGroupRequest.Builder`	`desiredCapacity(Integer desiredCapacity)` The expected number of ECS instances or elastic container instances in the scaling group.
`ModifyScalingGroupRequest.Builder`	`disableDesiredCapacity(Boolean disableDesiredCapacity)` DisableDesiredCapacity.
`ModifyScalingGroupRequest.Builder`	`groupDeletionProtection(Boolean groupDeletionProtection)` Specifies whether to enable deletion protection for the scaling group.
`ModifyScalingGroupRequest.Builder`	`healthCheckType(String healthCheckType)` The health check mode of the scaling group.
`ModifyScalingGroupRequest.Builder`	`healthCheckTypes(List<String> healthCheckTypes)` The health check modes of the scaling group.
`ModifyScalingGroupRequest.Builder`	`launchTemplateId(String launchTemplateId)` The ID of the launch template that is used by Auto Scaling to create instances.
`ModifyScalingGroupRequest.Builder`	`launchTemplateOverrides(List<ModifyScalingGroupRequest.LaunchTemplateOverrides> launchTemplateOverrides)` Details of the instance types that are specified in the extended configurations of the launch template.
`ModifyScalingGroupRequest.Builder`	`launchTemplateVersion(String launchTemplateVersion)` The version number of the launch template.
`ModifyScalingGroupRequest.Builder`	`maxInstanceLifetime(Integer maxInstanceLifetime)` The maximum life span of the instance in the scaling group.
`ModifyScalingGroupRequest.Builder`	`maxSize(Integer maxSize)` The maximum number of ECS instances or elastic container instances that can be contained in the scaling group.
`ModifyScalingGroupRequest.Builder`	`minSize(Integer minSize)` The minimum number of ECS instances or elastic container instances that must be contained in the scaling group.
`ModifyScalingGroupRequest.Builder`	`multiAZPolicy(String multiAZPolicy)` The scaling policy for the multi-zone scaling group that contains ECS instances.
`ModifyScalingGroupRequest.Builder`	`onDemandBaseCapacity(Integer onDemandBaseCapacity)` The minimum number of pay-as-you-go instances that must be included in the scaling group.
`ModifyScalingGroupRequest.Builder`	`onDemandPercentageAboveBaseCapacity(Integer onDemandPercentageAboveBaseCapacity)` The expected percentage of pay-as-you-go instances in the excess instances when the minimum number of pay-as-you-go instances reaches the requirement.
`ModifyScalingGroupRequest.Builder`	`ownerAccount(String ownerAccount)` OwnerAccount.
`ModifyScalingGroupRequest.Builder`	`ownerId(Long ownerId)` OwnerId.
`ModifyScalingGroupRequest.Builder`	`removalPolicies(List<String> removalPolicies)` The policy that is used to remove ECS instances from the scaling group.
`ModifyScalingGroupRequest.Builder`	`resourceOwnerAccount(String resourceOwnerAccount)` ResourceOwnerAccount.
`ModifyScalingGroupRequest.Builder`	`resourceOwnerId(Long resourceOwnerId)` ResourceOwnerId.
`ModifyScalingGroupRequest.Builder`	`scalingGroupId(String scalingGroupId)` The ID of the scaling group that you want to modify.
`ModifyScalingGroupRequest.Builder`	`scalingGroupName(String scalingGroupName)` The name of the scaling group.
`ModifyScalingGroupRequest.Builder`	`scalingPolicy(String scalingPolicy)` The reclaim mode of the scaling group.
`ModifyScalingGroupRequest.Builder`	`spotAllocationStrategy(String spotAllocationStrategy)` The allocation policy of preemptible instances.
`ModifyScalingGroupRequest.Builder`	`spotInstancePools(Integer spotInstancePools)` The number of instance types that you specify.
`ModifyScalingGroupRequest.Builder`	`spotInstanceRemedy(Boolean spotInstanceRemedy)` Specifies whether to supplement preemptible instances.
`ModifyScalingGroupRequest.Builder`	`vSwitchIds(List<String> vSwitchIds)` The IDs of vSwitches.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - activeScalingConfigurationId
```
public ModifyScalingGroupRequest.Builder activeScalingConfigurationId(String activeScalingConfigurationId)
```
    The ID of the active scaling configuration in the scaling group.
  - allocationStrategy
```
public ModifyScalingGroupRequest.Builder allocationStrategy(String allocationStrategy)
```
    The allocation policy. 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 at the same time. This parameter takes effect only when you set the MultiAZPolicy parameter 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
```
public ModifyScalingGroupRequest.Builder azBalance(Boolean azBalance)
```
    Specifies whether to evenly distribute instances in the scaling group across zones. This parameter takes effect only when you set the `MultiAZPolicy` parameter to `COMPOSABLE`. Valid values:
    * true * false Default value: false.
  - compensateWithOnDemand
```
public ModifyScalingGroupRequest.Builder compensateWithOnDemand(Boolean compensateWithOnDemand)
```
    Specifies whether to automatically create pay-as-you-go instances to meet the requirements on the number of ECS instances in the scaling group when the number of preemptible instances cannot be reached due to reasons such as cost-related issues and insufficient resources. This parameter takes effect only if you set `MultiAZPolicy` in the `CreateScalingGroup` operation to `COST_OPTIMIZED`. Valid values:
    * true * false
  - customPolicyARN
```
public ModifyScalingGroupRequest.Builder customPolicyARN(String customPolicyARN)
```
    The ARN of the custom scaling policy (Function). This parameter takes effect only when you specify CustomPolicy as the first step of the instance removal policy.
  - defaultCooldown
```
public ModifyScalingGroupRequest.Builder defaultCooldown(Integer defaultCooldown)
```
    The cooldown period of the scaling group. This parameter is available only if you set ScalingRuleType to SimpleScalingRule. Valid values: 0 to 86400. Unit: seconds.
    During the cooldown period, Auto Scaling does not execute scaling activities that are triggered by CloudMonitor event-triggered tasks.
  - desiredCapacity
```
public ModifyScalingGroupRequest.Builder desiredCapacity(Integer desiredCapacity)
```
    The expected number of ECS instances or elastic container instances in the scaling group. Auto Scaling maintains the expected number of ECS instances or elastic container instances in the scaling group. Make sure that you adhere to the following rule when specifying this parameter: Value of MaxSize ≥ Value of DesiredCapacity ≥ Value of MinSize
    > If you re-enable the Expected Number of Instances feature, you must specify a value for `DesiredCapacity` again.
  - disableDesiredCapacity
```
public ModifyScalingGroupRequest.Builder disableDesiredCapacity(Boolean disableDesiredCapacity)
```
    DisableDesiredCapacity.
  - groupDeletionProtection
```
public ModifyScalingGroupRequest.Builder groupDeletionProtection(Boolean groupDeletionProtection)
```
    Specifies whether to enable deletion protection for the scaling group. Valid values:
    * true: enables deletion protection for the scaling group. This way, the scaling group cannot be deleted. * false: disables deletion protection for the scaling group.
  - healthCheckType
```
public ModifyScalingGroupRequest.Builder healthCheckType(String healthCheckType)
```
    The health check mode of the scaling group. Valid values:
    * NONE: Auto Scaling does not perform health checks. * ECS: Auto Scaling checks the health status of ECS instances in the scaling group. * ECI: Auto Scaling checks the health status of elastic container instances in the scaling group. * LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group based on the health check results of load balancers. The health check results of Classic Load Balancer (CLB) instances are not supported as the health check basis for instances in the scaling group. > HealthCheckType has the same effect as `HealthCheckTypes`. You can select one of them to specify based on your business requirements. If you specify `HealthCheckTypes`, `HealthCheckType` is ignored. HealthCheckType is optional.
  - healthCheckTypes
```
public ModifyScalingGroupRequest.Builder healthCheckTypes(List<String> healthCheckTypes)
```
    The health check modes of the scaling group. Valid values:
    * NONE: Auto Scaling does not perform health checks. * ECS: Auto Scaling checks the health status of ECS instances in the scaling group. * ECI: Auto Scaling checks the health status of elastic container instances in the scaling group. * LOAD_BALANCER: Auto Scaling checks the health status of instances in the scaling group based on the health check results of load balancers. The health check results of CLB instances are not supported as the health check basis for instances in the scaling group.
  - launchTemplateId
```
public ModifyScalingGroupRequest.Builder launchTemplateId(String launchTemplateId)
```
    The ID of the launch template that is used by Auto Scaling to create instances.
  - launchTemplateOverrides
```
public ModifyScalingGroupRequest.Builder launchTemplateOverrides(List<ModifyScalingGroupRequest.LaunchTemplateOverrides> launchTemplateOverrides)
```
    Details of the instance types that are specified in the extended configurations of the launch template.
  - launchTemplateVersion
```
public ModifyScalingGroupRequest.Builder launchTemplateVersion(String launchTemplateVersion)
```
    The version number of the launch template. Valid values:
    * A fixed template version number. * Default: The default template version is always used. * Latest: The latest template version is always used.
  - maxInstanceLifetime
```
public ModifyScalingGroupRequest.Builder maxInstanceLifetime(Integer maxInstanceLifetime)
```
    The maximum life span of the instance in the scaling group. Unit: seconds.
    Valid values: 86400 to Integer.maxValue. ``You can also set this parameter to 0. A value of 0 indicates that the instance has an unlimited life span in the scaling group. Default value: null. > You cannot specify this parameter for scaling groups that manage elastic container instances or scaling groups whose ScalingPolicy is set to recycle.
  - maxSize
```
public ModifyScalingGroupRequest.Builder maxSize(Integer maxSize)
```
    The maximum number of ECS instances or elastic container instances that can be contained in the scaling group. If the total number of instances in the scaling group is greater than the value of MaxSize, Auto Scaling proactively removes the surplus instances from the scaling group to restore the total number to match the maximum limit.
    The value range of MaxSize is directly correlated with the degree of dependency your business has on Auto Scaling. You can go to [Quota Center](https://quotas.console.aliyun.com/products/ess/quotas) to check **the maximum number of instances that a single scaling group can contain.** For example, if a scaling group can contain up to **2,000** instances, the value range of MaxSize is 0 to 2000.
  - minSize
```
public ModifyScalingGroupRequest.Builder minSize(Integer minSize)
```
    The minimum number of ECS instances or elastic container instances that must be contained in the scaling group. If the total number of instances in the scaling group is less than the value of MinSize, Auto Scaling proactively adds instances to the scaling group to ensure that the total number aligns with the minimum threshold.
    > The value of MinSize must be less than or equal to the value of MaxSize.
  - multiAZPolicy
```
public ModifyScalingGroupRequest.Builder multiAZPolicy(String multiAZPolicy)
```
    The scaling policy for the multi-zone scaling group that contains ECS instances. Valid values:
    * PRIORITY: ECS instances are scaled based on the vSwitch priority. The first vSwitch specified by using the VSwitchIds parameter has the highest priority. 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: During a scale-out activity, Auto Scaling preferentially creates ECS instances of the instance type that has the lowest unit price of vCPU. During a scale-in activity, Auto Scaling preferentially removes ECS instances of the instance types that have the highest unit price of vCPU. Auto Scaling preferentially creates preemptible instances when preemptible instance types are specified in the scaling configuration. You can use the `CompensateWithOnDemand` parameter to specify whether to automatically create pay-as-you-go instances when Auto Scaling fails to create preemptible instances. > The `COST_OPTIMIZED` setting takes effect only when multiple instance types are specified or at least one instance type is specified for preemptible instances. * BALANCE: ECS instances are evenly distributed across zones that are specified in the scaling group. If ECS instances are unevenly distributed among zones due to insufficient resources, you can call the RebalanceInstance operation to evenly distribute the instances among the zones. * COMPOSABLE: You can flexibly combine the preceding policies based on your business requirements.
  - onDemandBaseCapacity
```
public ModifyScalingGroupRequest.Builder onDemandBaseCapacity(Integer onDemandBaseCapacity)
```
    The minimum number of pay-as-you-go instances that must be included 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 the `MultiAZPolicy` parameter to `COMPOSABLE` Policy, the default value is 0.
  - onDemandPercentageAboveBaseCapacity
```
public ModifyScalingGroupRequest.Builder onDemandPercentageAboveBaseCapacity(Integer onDemandPercentageAboveBaseCapacity)
```
    The expected percentage of pay-as-you-go instances in the excess instances when the minimum number of pay-as-you-go instances reaches the requirement. Valid values: 0 to 100.
    If you set the `MultiAZPolicy` parameter to `COMPOSABLE` Policy, the default value is 100.
  - ownerAccount
```
public ModifyScalingGroupRequest.Builder ownerAccount(String ownerAccount)
```
    OwnerAccount.
  - ownerId
```
public ModifyScalingGroupRequest.Builder ownerId(Long ownerId)
```
    OwnerId.
  - removalPolicies
```
public ModifyScalingGroupRequest.Builder removalPolicies(List<String> removalPolicies)
```
    The policy that is used to remove ECS instances from the scaling group. Valid values:
    * OldestInstance: removes ECS instances that are added at the earliest point in time to the scaling group. * NewestInstance: removes ECS instances that are most recently added to the scaling group. * OldestScalingConfiguration: removes ECS instances that are created based on the earliest scaling configuration.
  - resourceOwnerAccount
```
public ModifyScalingGroupRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)
```
    ResourceOwnerAccount.
  - resourceOwnerId
```
public ModifyScalingGroupRequest.Builder resourceOwnerId(Long resourceOwnerId)
```
    ResourceOwnerId.
  - scalingGroupId
```
public ModifyScalingGroupRequest.Builder scalingGroupId(String scalingGroupId)
```
    The ID of the scaling group that you want to modify.
  - scalingGroupName
```
public ModifyScalingGroupRequest.Builder scalingGroupName(String 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.
  - scalingPolicy
```
public ModifyScalingGroupRequest.Builder scalingPolicy(String scalingPolicy)
```
    The reclaim mode of the scaling group. Valid values:
    * recycle: economical mode * release: release mode * forcerelease: forced release mode ** **Note** If you set the value to `forcerelease`, Auto Scaling forcibly releases instances that are in the `Running` state during scale-ins. Forced release is equivalent to power outage. If an instance is forcibly released, ephemeral data on the instance will be cleared and cannot be recovered. Exercise caution when you select this option. * forcerecycle: forced recycle mode ** **Note** If you set the value to `forcerecycle`, Auto Scaling forcibly shuts down instances that are in the `Running` state during scale-ins. Forced shutdown is equivalent to power outage. If an instance is forcibly shut down, ephemeral data on the instance will be cleared and cannot be recovered. Exercise caution when you select this option. ScalingPolicy specifies only the reclaim mode of the scaling group. RemovePolicy of the RemoveInstances operation specifies the manner how instances are removed from the scaling group. For more information, see [RemoveInstances](~~25955~~).
  - spotAllocationStrategy
```
public ModifyScalingGroupRequest.Builder spotAllocationStrategy(String 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 when you set the `MultiAZPolicy` parameter 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
```
public ModifyScalingGroupRequest.Builder spotInstancePools(Integer spotInstancePools)
```
    The number of instance types that you specify. Auto Scaling creates preemptible instances of multiple instance types that are provided at the lowest price. Valid values: 0 to 10.
    If you set the `MultiAZPolicy` parameter to `COMPOSABLE` Policy, the default value is 2.
  - spotInstanceRemedy
```
public ModifyScalingGroupRequest.Builder spotInstanceRemedy(Boolean spotInstanceRemedy)
```
    Specifies whether to supplement preemptible instances. If this parameter is set to true, Auto Scaling creates an instance to replace a preemptible instance when Auto Scaling receives the system message that the preemptible instance is to be reclaimed.
  - vSwitchIds
```
public ModifyScalingGroupRequest.Builder vSwitchIds(List<String> vSwitchIds)
```
    The IDs of vSwitches.
    This parameter takes effect only when the network type of the scaling group is virtual private cloud (VPC). The specified vSwitches and the scaling group must reside in the same VPC. The vSwitches can reside in different zones. The vSwitches are sorted in ascending order. The first vSwitch specified by using the VSwitchIds 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.
  - build
```
public ModifyScalingGroupRequest build()
```

类 ModifyScalingGroupRequest.Builder

方法概要

从类继承的方法 java.lang.Object

方法详细资料

activeScalingConfigurationId

allocationStrategy

azBalance

compensateWithOnDemand

customPolicyARN

defaultCooldown

desiredCapacity

disableDesiredCapacity

groupDeletionProtection

healthCheckType

healthCheckTypes

launchTemplateId

launchTemplateOverrides

launchTemplateVersion

maxInstanceLifetime

maxSize

minSize

multiAZPolicy

onDemandBaseCapacity

onDemandPercentageAboveBaseCapacity

ownerAccount

ownerId

removalPolicies

resourceOwnerAccount

resourceOwnerId

scalingGroupId

scalingGroupName

scalingPolicy

spotAllocationStrategy

spotInstancePools

spotInstanceRemedy

vSwitchIds

build