Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
__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 DescribeAutoScalingGroups API. To view the scaling policies for an Auto Scaling group, call the DescribePolicies API. If the group has scaling policies, you can update them by calling the PutScalingPolicy API.
Synopsis
- data UpdateAutoScalingGroup = UpdateAutoScalingGroup' {
- availabilityZones :: Maybe [Text]
- capacityRebalance :: Maybe Bool
- context :: Maybe Text
- defaultCooldown :: Maybe Int
- defaultInstanceWarmup :: Maybe Int
- desiredCapacity :: Maybe Int
- desiredCapacityType :: Maybe Text
- healthCheckGracePeriod :: Maybe Int
- healthCheckType :: Maybe Text
- launchConfigurationName :: Maybe Text
- launchTemplate :: Maybe LaunchTemplateSpecification
- maxInstanceLifetime :: Maybe Int
- maxSize :: Maybe Int
- minSize :: Maybe Int
- mixedInstancesPolicy :: Maybe MixedInstancesPolicy
- newInstancesProtectedFromScaleIn' :: Maybe Bool
- placementGroup :: Maybe Text
- serviceLinkedRoleARN :: Maybe Text
- terminationPolicies :: Maybe [Text]
- vPCZoneIdentifier :: Maybe Text
- autoScalingGroupName :: Text
- newUpdateAutoScalingGroup :: Text -> UpdateAutoScalingGroup
- updateAutoScalingGroup_availabilityZones :: Lens' UpdateAutoScalingGroup (Maybe [Text])
- updateAutoScalingGroup_capacityRebalance :: Lens' UpdateAutoScalingGroup (Maybe Bool)
- updateAutoScalingGroup_context :: Lens' UpdateAutoScalingGroup (Maybe Text)
- updateAutoScalingGroup_defaultCooldown :: Lens' UpdateAutoScalingGroup (Maybe Int)
- updateAutoScalingGroup_defaultInstanceWarmup :: Lens' UpdateAutoScalingGroup (Maybe Int)
- updateAutoScalingGroup_desiredCapacity :: Lens' UpdateAutoScalingGroup (Maybe Int)
- updateAutoScalingGroup_desiredCapacityType :: Lens' UpdateAutoScalingGroup (Maybe Text)
- updateAutoScalingGroup_healthCheckGracePeriod :: Lens' UpdateAutoScalingGroup (Maybe Int)
- updateAutoScalingGroup_healthCheckType :: Lens' UpdateAutoScalingGroup (Maybe Text)
- updateAutoScalingGroup_launchConfigurationName :: Lens' UpdateAutoScalingGroup (Maybe Text)
- updateAutoScalingGroup_launchTemplate :: Lens' UpdateAutoScalingGroup (Maybe LaunchTemplateSpecification)
- updateAutoScalingGroup_maxInstanceLifetime :: Lens' UpdateAutoScalingGroup (Maybe Int)
- updateAutoScalingGroup_maxSize :: Lens' UpdateAutoScalingGroup (Maybe Int)
- updateAutoScalingGroup_minSize :: Lens' UpdateAutoScalingGroup (Maybe Int)
- updateAutoScalingGroup_mixedInstancesPolicy :: Lens' UpdateAutoScalingGroup (Maybe MixedInstancesPolicy)
- updateAutoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' UpdateAutoScalingGroup (Maybe Bool)
- updateAutoScalingGroup_placementGroup :: Lens' UpdateAutoScalingGroup (Maybe Text)
- updateAutoScalingGroup_serviceLinkedRoleARN :: Lens' UpdateAutoScalingGroup (Maybe Text)
- updateAutoScalingGroup_terminationPolicies :: Lens' UpdateAutoScalingGroup (Maybe [Text])
- updateAutoScalingGroup_vPCZoneIdentifier :: Lens' UpdateAutoScalingGroup (Maybe Text)
- updateAutoScalingGroup_autoScalingGroupName :: Lens' UpdateAutoScalingGroup Text
- data UpdateAutoScalingGroupResponse = UpdateAutoScalingGroupResponse' {
- newUpdateAutoScalingGroupResponse :: UpdateAutoScalingGroupResponse
Creating a Request
data UpdateAutoScalingGroup Source #
See: newUpdateAutoScalingGroup
smart constructor.
UpdateAutoScalingGroup' | |
|
Instances
newUpdateAutoScalingGroup Source #
Create a value of UpdateAutoScalingGroup
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateAutoScalingGroup
, updateAutoScalingGroup_availabilityZones
- One or more Availability Zones for the group.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_context
- Reserved.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_defaultInstanceWarmup
- The amount of time, in seconds, until a newly launched instance can
contribute to the Amazon CloudWatch metrics. This delay lets an instance
finish initializing before Amazon EC2 Auto Scaling aggregates instance
metrics, resulting in more reliable usage data. Set this value equal to
the amount of time that it takes for resource consumption to become
stable after an instance reaches the InService
state. For more
information, see
Set the default instance warmup for an Auto Scaling group
in the Amazon EC2 Auto Scaling User Guide.
To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, /even if its value is set to 0 seconds/. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.
If you need 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 minimum
value of 0
.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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
Creating an Auto Scaling 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
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_healthCheckType
- Determines whether any additional health checks are performed on the
instances in this group. Amazon EC2 health checks are always on.
The valid values are EC2
(default), ELB
, and VPC_LATTICE
. The
VPC_LATTICE
health check type is reserved for use with VPC Lattice,
which is in preview release and is subject to change.
UpdateAutoScalingGroup
, updateAutoScalingGroup_launchConfigurationName
- The name of the launch configuration. If you specify
LaunchConfigurationName
in your update request, you can't specify
LaunchTemplate
or MixedInstancesPolicy
.
UpdateAutoScalingGroup
, updateAutoScalingGroup_launchTemplate
- 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
.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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 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).
UpdateAutoScalingGroup
, updateAutoScalingGroup_minSize
- The minimum size of the Auto Scaling group.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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
Using instance scale-in protection
in the Amazon EC2 Auto Scaling User Guide.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_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
Work with Amazon EC2 Auto Scaling termination policies
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
UpdateAutoScalingGroup
, updateAutoScalingGroup_vPCZoneIdentifier
- 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.
UpdateAutoScalingGroup
, updateAutoScalingGroup_autoScalingGroupName
- The name of the Auto Scaling group.
Request Lenses
updateAutoScalingGroup_availabilityZones :: Lens' UpdateAutoScalingGroup (Maybe [Text]) Source #
One or more Availability Zones for the group.
updateAutoScalingGroup_capacityRebalance :: Lens' UpdateAutoScalingGroup (Maybe Bool) Source #
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.
updateAutoScalingGroup_context :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #
Reserved.
updateAutoScalingGroup_defaultCooldown :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #
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.
updateAutoScalingGroup_defaultInstanceWarmup :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #
The amount of time, in seconds, until a newly launched instance can
contribute to the Amazon CloudWatch metrics. This delay lets an instance
finish initializing before Amazon EC2 Auto Scaling aggregates instance
metrics, resulting in more reliable usage data. Set this value equal to
the amount of time that it takes for resource consumption to become
stable after an instance reaches the InService
state. For more
information, see
Set the default instance warmup for an Auto Scaling group
in the Amazon EC2 Auto Scaling User Guide.
To manage your warm-up settings at the group level, we recommend that you set the default instance warmup, /even if its value is set to 0 seconds/. This also optimizes the performance of scaling policies that scale continuously, such as target tracking and step scaling policies.
If you need 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 minimum
value of 0
.
updateAutoScalingGroup_desiredCapacity :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #
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.
updateAutoScalingGroup_desiredCapacityType :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #
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
Creating an Auto Scaling 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
updateAutoScalingGroup_healthCheckGracePeriod :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #
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.
updateAutoScalingGroup_healthCheckType :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #
Determines whether any additional health checks are performed on the instances in this group. Amazon EC2 health checks are always on.
The valid values are EC2
(default), ELB
, and VPC_LATTICE
. The
VPC_LATTICE
health check type is reserved for use with VPC Lattice,
which is in preview release and is subject to change.
updateAutoScalingGroup_launchConfigurationName :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #
The name of the launch configuration. If you specify
LaunchConfigurationName
in your update request, you can't specify
LaunchTemplate
or MixedInstancesPolicy
.
updateAutoScalingGroup_launchTemplate :: Lens' UpdateAutoScalingGroup (Maybe LaunchTemplateSpecification) Source #
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
.
updateAutoScalingGroup_maxInstanceLifetime :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #
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.
updateAutoScalingGroup_maxSize :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #
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).
updateAutoScalingGroup_minSize :: Lens' UpdateAutoScalingGroup (Maybe Int) Source #
The minimum size of the Auto Scaling group.
updateAutoScalingGroup_mixedInstancesPolicy :: Lens' UpdateAutoScalingGroup (Maybe MixedInstancesPolicy) Source #
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.
updateAutoScalingGroup_newInstancesProtectedFromScaleIn :: Lens' UpdateAutoScalingGroup (Maybe Bool) Source #
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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
updateAutoScalingGroup_placementGroup :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #
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.
updateAutoScalingGroup_serviceLinkedRoleARN :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #
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.
updateAutoScalingGroup_terminationPolicies :: Lens' UpdateAutoScalingGroup (Maybe [Text]) Source #
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 Work with Amazon EC2 Auto Scaling termination policies 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
updateAutoScalingGroup_vPCZoneIdentifier :: Lens' UpdateAutoScalingGroup (Maybe Text) Source #
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.
updateAutoScalingGroup_autoScalingGroupName :: Lens' UpdateAutoScalingGroup Text Source #
The name of the Auto Scaling group.
Destructuring the Response
data UpdateAutoScalingGroupResponse Source #
See: newUpdateAutoScalingGroupResponse
smart constructor.
Instances
newUpdateAutoScalingGroupResponse :: UpdateAutoScalingGroupResponse Source #
Create a value of UpdateAutoScalingGroupResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.