Update Auto Scaling Group
autoscaling_update_auto_scaling_group | R Documentation |
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2¶
Description¶
We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Updates the configuration for the specified Auto Scaling group.
To update an Auto Scaling group, specify the name of the group and the property that you want to change. Any properties that you don't specify are not changed by this update request. The new settings take effect on any scaling activities after this call returns.
If you associate a new launch configuration or template with an Auto Scaling group, all new instances will get the updated configuration. Existing instances continue to run with the configuration that they were originally launched with. When you update a group to specify a mixed instances policy instead of a launch configuration or template, existing instances may be replaced to match the new purchasing options that you specified in the policy. For example, if the group currently has 100% On-Demand capacity and the policy specifies 50% Spot capacity, this means that half of your instances will be gradually terminated and relaunched as Spot Instances. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones, so that updating your group does not compromise the performance or availability of your application.
Note the following about changing DesiredCapacity
, MaxSize
, or
MinSize
:
-
If a scale-in activity occurs as a result of a new
DesiredCapacity
value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate. -
If you specify a new value for
MinSize
without specifying a value forDesiredCapacity
, and the newMinSize
is larger than the current size of the group, this sets the group'sDesiredCapacity
to the newMinSize
value. -
If you specify a new value for
MaxSize
without specifying a value forDesiredCapacity
, and the newMaxSize
is smaller than the current size of the group, this sets the group'sDesiredCapacity
to the newMaxSize
value.
To see which properties have been set, call the
describe_auto_scaling_groups
API. To view the scaling policies for an
Auto Scaling group, call the describe_policies
API. If the group has
scaling policies, you can update them by calling the
put_scaling_policy
API.
Usage¶
autoscaling_update_auto_scaling_group(AutoScalingGroupName,
LaunchConfigurationName, LaunchTemplate, MixedInstancesPolicy, MinSize,
MaxSize, DesiredCapacity, DefaultCooldown, AvailabilityZones,
HealthCheckType, HealthCheckGracePeriod, PlacementGroup,
VPCZoneIdentifier, TerminationPolicies,
NewInstancesProtectedFromScaleIn, ServiceLinkedRoleARN,
MaxInstanceLifetime, CapacityRebalance, Context, DesiredCapacityType,
DefaultInstanceWarmup, InstanceMaintenancePolicy)
Arguments¶
AutoScalingGroupName
[required] The name of the Auto Scaling group.
LaunchConfigurationName
The name of the launch configuration. If you specify
LaunchConfigurationName
in your update request, you can't specifyLaunchTemplate
orMixedInstancesPolicy
.LaunchTemplate
The launch template and version to use to specify the updates. If you specify
LaunchTemplate
in your update request, you can't specifyLaunchConfigurationName
orMixedInstancesPolicy
.MixedInstancesPolicy
The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
MinSize
The minimum size of the Auto Scaling group.
MaxSize
The maximum size of the Auto Scaling group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize
to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSize
by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).DesiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.
DefaultCooldown
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
AvailabilityZones
One or more Availability Zones for the group.
HealthCheckType
A comma-separated value string of one or more health check types.
The valid values are
EC2
,EBS
,ELB
, andVPC_LATTICE
.EC2
is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.Only specify
EC2
if you must clear a value that was previously set.HealthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the
InService
state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.PlacementGroup
The name of an existing placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
VPCZoneIdentifier
A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify
VPCZoneIdentifier
withAvailabilityZones
, the subnets that you specify must reside in those Availability Zones.TerminationPolicies
A policy or a list of policies that are used to select the instances to terminate. The policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Valid values:
Default
|AllocationStrategy
|ClosestToNextInstanceHour
|NewestInstance
|OldestInstance
|OldestLaunchConfiguration
|OldestLaunchTemplate
|arn:aws:lambda:region:account-id:function:my-function:my-alias
NewInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
ServiceLinkedRoleARN
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.
MaxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). To clear a previously set value, specify a new value of 0. For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
CapacityRebalance
Enables or disables Capacity Rebalancing. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the Amazon EC2 Auto Scaling User Guide.
Context
Reserved.
DesiredCapacityType
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityType
for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.By default, Amazon EC2 Auto Scaling specifies
units
, which translates into number of instances.Valid values:
units
|vcpu
|memory-mib
DefaultInstanceWarmup
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the
InService
state.During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify
-1
for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0
or other nominal value.InstanceMaintenancePolicy
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
Value¶
An empty list.
Request syntax¶
svc$update_auto_scaling_group(
AutoScalingGroupName = "string",
LaunchConfigurationName = "string",
LaunchTemplate = list(
LaunchTemplateId = "string",
LaunchTemplateName = "string",
Version = "string"
),
MixedInstancesPolicy = list(
LaunchTemplate = list(
LaunchTemplateSpecification = list(
LaunchTemplateId = "string",
LaunchTemplateName = "string",
Version = "string"
),
Overrides = list(
list(
InstanceType = "string",
WeightedCapacity = "string",
LaunchTemplateSpecification = list(
LaunchTemplateId = "string",
LaunchTemplateName = "string",
Version = "string"
),
InstanceRequirements = list(
VCpuCount = list(
Min = 123,
Max = 123
),
MemoryMiB = list(
Min = 123,
Max = 123
),
CpuManufacturers = list(
"intel"|"amd"|"amazon-web-services"
),
MemoryGiBPerVCpu = list(
Min = 123.0,
Max = 123.0
),
ExcludedInstanceTypes = list(
"string"
),
InstanceGenerations = list(
"current"|"previous"
),
SpotMaxPricePercentageOverLowestPrice = 123,
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123,
OnDemandMaxPricePercentageOverLowestPrice = 123,
BareMetal = "included"|"excluded"|"required",
BurstablePerformance = "included"|"excluded"|"required",
RequireHibernateSupport = TRUE|FALSE,
NetworkInterfaceCount = list(
Min = 123,
Max = 123
),
LocalStorage = "included"|"excluded"|"required",
LocalStorageTypes = list(
"hdd"|"ssd"
),
TotalLocalStorageGB = list(
Min = 123.0,
Max = 123.0
),
BaselineEbsBandwidthMbps = list(
Min = 123,
Max = 123
),
AcceleratorTypes = list(
"gpu"|"fpga"|"inference"
),
AcceleratorCount = list(
Min = 123,
Max = 123
),
AcceleratorManufacturers = list(
"nvidia"|"amd"|"amazon-web-services"|"xilinx"
),
AcceleratorNames = list(
"a100"|"v100"|"k80"|"t4"|"m60"|"radeon-pro-v520"|"vu9p"
),
AcceleratorTotalMemoryMiB = list(
Min = 123,
Max = 123
),
NetworkBandwidthGbps = list(
Min = 123.0,
Max = 123.0
),
AllowedInstanceTypes = list(
"string"
)
)
)
)
),
InstancesDistribution = list(
OnDemandAllocationStrategy = "string",
OnDemandBaseCapacity = 123,
OnDemandPercentageAboveBaseCapacity = 123,
SpotAllocationStrategy = "string",
SpotInstancePools = 123,
SpotMaxPrice = "string"
)
),
MinSize = 123,
MaxSize = 123,
DesiredCapacity = 123,
DefaultCooldown = 123,
AvailabilityZones = list(
"string"
),
HealthCheckType = "string",
HealthCheckGracePeriod = 123,
PlacementGroup = "string",
VPCZoneIdentifier = "string",
TerminationPolicies = list(
"string"
),
NewInstancesProtectedFromScaleIn = TRUE|FALSE,
ServiceLinkedRoleARN = "string",
MaxInstanceLifetime = 123,
CapacityRebalance = TRUE|FALSE,
Context = "string",
DesiredCapacityType = "string",
DefaultInstanceWarmup = 123,
InstanceMaintenancePolicy = list(
MinHealthyPercentage = 123,
MaxHealthyPercentage = 123
)
)
Examples¶
## Not run:
# This example updates multiple properties at the same time.
svc$update_auto_scaling_group(
AutoScalingGroupName = "my-auto-scaling-group",
LaunchTemplate = list(
LaunchTemplateName = "my-template-for-auto-scaling",
Version = "2"
),
MaxSize = 5L,
MinSize = 1L,
NewInstancesProtectedFromScaleIn = TRUE
)
## End(Not run)