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 |
Synopsis
- data RefreshPreferences = RefreshPreferences' {}
- newRefreshPreferences :: RefreshPreferences
- refreshPreferences_checkpointDelay :: Lens' RefreshPreferences (Maybe Natural)
- refreshPreferences_checkpointPercentages :: Lens' RefreshPreferences (Maybe [Natural])
- refreshPreferences_instanceWarmup :: Lens' RefreshPreferences (Maybe Natural)
- refreshPreferences_minHealthyPercentage :: Lens' RefreshPreferences (Maybe Natural)
- refreshPreferences_skipMatching :: Lens' RefreshPreferences (Maybe Bool)
Documentation
data RefreshPreferences Source #
Describes the preferences for an instance refresh.
See: newRefreshPreferences
smart constructor.
RefreshPreferences' | |
|
Instances
newRefreshPreferences :: RefreshPreferences Source #
Create a value of RefreshPreferences
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:
$sel:checkpointDelay:RefreshPreferences'
, refreshPreferences_checkpointDelay
- The amount of time, in seconds, to wait after a checkpoint before
continuing. This property is optional, but if you specify a value for
it, you must also specify a value for CheckpointPercentages
. If you
specify a value for CheckpointPercentages
and not for
CheckpointDelay
, the CheckpointDelay
defaults to 3600
(1 hour).
$sel:checkpointPercentages:RefreshPreferences'
, refreshPreferences_checkpointPercentages
- Threshold values for each checkpoint in ascending order. Each number
must be unique. To replace all instances in the Auto Scaling group, the
last number in the array must be 100
.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
$sel:instanceWarmup:RefreshPreferences'
, refreshPreferences_instanceWarmup
- Not needed if the default instance warmup is defined for the group.
The duration of the instance warmup, in seconds.
The default is to use the value for the default instance warmup defined
for the group. If default instance warmup is null, then InstanceWarmup
falls back to the value of the health check grace period.
$sel:minHealthyPercentage:RefreshPreferences'
, refreshPreferences_minHealthyPercentage
- The amount of capacity in the Auto Scaling group that must pass your
group's health checks to allow the operation to continue. The value is
expressed as a percentage of the desired capacity of the Auto Scaling
group (rounded up to the nearest integer). The default is 90
.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
$sel:skipMatching:RefreshPreferences'
, refreshPreferences_skipMatching
- A boolean value that indicates whether skip matching is enabled. If
true, then Amazon EC2 Auto Scaling skips replacing instances that match
the desired configuration. If no desired configuration is specified,
then it skips replacing instances that have the same configuration that
is already set on the group. The default is false
.
refreshPreferences_checkpointDelay :: Lens' RefreshPreferences (Maybe Natural) Source #
The amount of time, in seconds, to wait after a checkpoint before
continuing. This property is optional, but if you specify a value for
it, you must also specify a value for CheckpointPercentages
. If you
specify a value for CheckpointPercentages
and not for
CheckpointDelay
, the CheckpointDelay
defaults to 3600
(1 hour).
refreshPreferences_checkpointPercentages :: Lens' RefreshPreferences (Maybe [Natural]) Source #
Threshold values for each checkpoint in ascending order. Each number
must be unique. To replace all instances in the Auto Scaling group, the
last number in the array must be 100
.
For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.
refreshPreferences_instanceWarmup :: Lens' RefreshPreferences (Maybe Natural) Source #
Not needed if the default instance warmup is defined for the group.
The duration of the instance warmup, in seconds.
The default is to use the value for the default instance warmup defined
for the group. If default instance warmup is null, then InstanceWarmup
falls back to the value of the health check grace period.
refreshPreferences_minHealthyPercentage :: Lens' RefreshPreferences (Maybe Natural) Source #
The amount of capacity in the Auto Scaling group that must pass your
group's health checks to allow the operation to continue. The value is
expressed as a percentage of the desired capacity of the Auto Scaling
group (rounded up to the nearest integer). The default is 90
.
Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.
refreshPreferences_skipMatching :: Lens' RefreshPreferences (Maybe Bool) Source #
A boolean value that indicates whether skip matching is enabled. If
true, then Amazon EC2 Auto Scaling skips replacing instances that match
the desired configuration. If no desired configuration is specified,
then it skips replacing instances that have the same configuration that
is already set on the group. The default is false
.