We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
See https://www.paws-r-sdk.com/docs/autoscaling_update_auto_scaling_group/ for full documentation.
autoscaling_update_auto_scaling_group(
AutoScalingGroupName,
LaunchConfigurationName = NULL,
LaunchTemplate = NULL,
MixedInstancesPolicy = NULL,
MinSize = NULL,
MaxSize = NULL,
DesiredCapacity = NULL,
DefaultCooldown = NULL,
AvailabilityZones = NULL,
HealthCheckType = NULL,
HealthCheckGracePeriod = NULL,
PlacementGroup = NULL,
VPCZoneIdentifier = NULL,
TerminationPolicies = NULL,
NewInstancesProtectedFromScaleIn = NULL,
ServiceLinkedRoleARN = NULL,
MaxInstanceLifetime = NULL,
CapacityRebalance = NULL,
Context = NULL,
DesiredCapacityType = NULL,
DefaultInstanceWarmup = NULL,
InstanceMaintenancePolicy = NULL,
AvailabilityZoneDistribution = NULL,
AvailabilityZoneImpairmentPolicy = NULL,
SkipZonalShiftValidation = NULL,
CapacityReservationSpecification = NULL
)
[required] The name of the Auto Scaling group.
The name of the launch configuration. If you specify
LaunchConfigurationName
in your update request, you can't specify
LaunchTemplate
or MixedInstancesPolicy
.
The launch template and version to use to specify the updates. If you
specify LaunchTemplate
in your update request, you can't specify
LaunchConfigurationName
or 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.
The minimum size of the Auto Scaling group.
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 above
MaxSize
by more than your largest instance weight (weights that define
how many units each instance contributes to the desired capacity of the
group).
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.
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.
One or more Availability Zones for the group.
A comma-separated value string of one or more health check types.
The valid values are EC2
, EBS
, ELB
, and VPC_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.
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.
The name of an existing placement group into which to launch your
instances. To remove the placement group setting, pass an empty string
for placement-group
. For more information about placement groups, 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.
A comma-separated list of subnet IDs for a virtual private cloud (VPC).
If you specify VPCZoneIdentifier
with AvailabilityZones
, the subnets
that you specify must reside in those Availability Zones.
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
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.
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.
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.
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.
Reserved.
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
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 of 0
or other
nominal value.
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
The instance capacity distribution across Availability Zones.
The policy for Availability Zone impairment.
If you enable zonal shift with cross-zone disabled load balancers,
capacity could become imbalanced across Availability Zones. To skip the
validation, specify true
. For more information, see Auto Scaling group zonal shift
in the Amazon EC2 Auto Scaling User Guide.
The capacity reservation specification for the Auto Scaling group.