Class: Aws::AutoScaling::Types::RefreshPreferences
- Inherits:
-
Struct
- Object
- Struct
- Aws::AutoScaling::Types::RefreshPreferences
- Defined in:
- gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb
Overview
Describes the preferences for an instance refresh.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#auto_rollback ⇒ Boolean
(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the instance refresh fails.
-
#checkpoint_delay ⇒ Integer
(Optional) The amount of time, in seconds, to wait after a checkpoint before continuing.
-
#checkpoint_percentages ⇒ Array<Integer>
(Optional) Threshold values for each checkpoint in ascending order.
-
#instance_warmup ⇒ Integer
A time period, in seconds, during which an instance refresh waits before moving on to replacing the next instance after a new instance enters the
InService
state. -
#min_healthy_percentage ⇒ Integer
The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the operation to continue.
-
#scale_in_protected_instances ⇒ String
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
-
#skip_matching ⇒ Boolean
(Optional) Indicates whether skip matching is enabled.
-
#standby_instances ⇒ String
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in
Standby
state are found.
Instance Attribute Details
#auto_rollback ⇒ Boolean
(Optional) Indicates whether to roll back the Auto Scaling group to
its previous configuration if the instance refresh fails. The
default is false
.
A rollback is not supported in the following situations:
There is no desired configuration specified for the instance refresh.
The Auto Scaling group has a launch template that uses an Amazon Web Services Systems Manager parameter instead of an AMI ID for the
ImageId
property.The Auto Scaling group uses the launch template's
$Latest
or$Default
version.
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |
#checkpoint_delay ⇒ Integer
(Optional) 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).
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |
#checkpoint_percentages ⇒ Array<Integer>
(Optional) 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.
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |
#instance_warmup ⇒ Integer
A time period, in seconds, during which an instance refresh waits
before moving on to replacing the next instance after a new instance
enters the InService
state.
This property is not required for normal usage. Instead, use the
DefaultInstanceWarmup
property of the Auto Scaling group. The
InstanceWarmup
and DefaultInstanceWarmup
properties work the
same way. Only specify this property if you must override the
DefaultInstanceWarmup
property.
If you do not specify this property, the instance warmup by default
is the value of the DefaultInstanceWarmup
property, if defined
(which is recommended in all cases), or the HealthCheckGracePeriod
property otherwise.
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |
#min_healthy_percentage ⇒ Integer
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.
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |
#scale_in_protected_instances ⇒ String
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
The following lists the valid values:
- Refresh
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
- Ignore
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
- Wait (default)
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |
#skip_matching ⇒ Boolean
(Optional) Indicates whether skip matching is enabled. If enabled
(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
launch template and instance types that the Auto Scaling group was
using before the start of the instance refresh. The default is
false
.
For more information, see Use an instance refresh with skip matching in the Amazon EC2 Auto Scaling User Guide.
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |
#standby_instances ⇒ String
Choose the behavior that you want Amazon EC2 Auto Scaling to use if
instances in Standby
state are found.
The following lists the valid values:
- Terminate
Amazon EC2 Auto Scaling terminates instances that are in
Standby
.- Ignore
Amazon EC2 Auto Scaling ignores instances that are in
Standby
and continues to replace instances that are in theInService
state.- Wait (default)
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 |
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 6329 class RefreshPreferences < Struct.new( :min_healthy_percentage, :instance_warmup, :checkpoint_percentages, :checkpoint_delay, :skip_matching, :auto_rollback, :scale_in_protected_instances, :standby_instances) SENSITIVE = [] include Aws::Structure end |