public static interface RefreshPreferences.Builder extends SdkPojo, CopyableBuilder<RefreshPreferences.Builder,RefreshPreferences>
| Modifier and Type | Method and Description |
|---|---|
RefreshPreferences.Builder |
alarmSpecification(AlarmSpecification alarmSpecification)
(Optional) The CloudWatch alarm specification.
|
default RefreshPreferences.Builder |
alarmSpecification(Consumer<AlarmSpecification.Builder> alarmSpecification)
(Optional) The CloudWatch alarm specification.
|
RefreshPreferences.Builder |
autoRollback(Boolean autoRollback)
(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the
instance refresh fails or a CloudWatch alarm threshold is met.
|
RefreshPreferences.Builder |
checkpointDelay(Integer checkpointDelay)
(Optional) The amount of time, in seconds, to wait after a checkpoint before continuing.
|
RefreshPreferences.Builder |
checkpointPercentages(Collection<Integer> checkpointPercentages)
(Optional) Threshold values for each checkpoint in ascending order.
|
RefreshPreferences.Builder |
checkpointPercentages(Integer... checkpointPercentages)
(Optional) Threshold values for each checkpoint in ascending order.
|
RefreshPreferences.Builder |
instanceWarmup(Integer instanceWarmup)
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. |
RefreshPreferences.Builder |
minHealthyPercentage(Integer minHealthyPercentage)
The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the
operation to continue.
|
RefreshPreferences.Builder |
scaleInProtectedInstances(ScaleInProtectedInstances scaleInProtectedInstances)
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are
found.
|
RefreshPreferences.Builder |
scaleInProtectedInstances(String scaleInProtectedInstances)
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are
found.
|
RefreshPreferences.Builder |
skipMatching(Boolean skipMatching)
(Optional) Indicates whether skip matching is enabled.
|
RefreshPreferences.Builder |
standbyInstances(StandbyInstances standbyInstances)
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in
Standby state
are found. |
RefreshPreferences.Builder |
standbyInstances(String standbyInstances)
Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in
Standby state
are found. |
equalsBySdkFields, sdkFieldscopyapplyMutation, buildRefreshPreferences.Builder minHealthyPercentage(Integer 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.
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.
RefreshPreferences.Builder instanceWarmup(Integer instanceWarmup)
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.
instanceWarmup - 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.
RefreshPreferences.Builder checkpointPercentages(Collection<Integer> checkpointPercentages)
(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.
checkpointPercentages - (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.
RefreshPreferences.Builder checkpointPercentages(Integer... checkpointPercentages)
(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.
checkpointPercentages - (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.
RefreshPreferences.Builder checkpointDelay(Integer checkpointDelay)
(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).
checkpointDelay - (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).RefreshPreferences.Builder skipMatching(Boolean skipMatching)
(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.
skipMatching - (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.
RefreshPreferences.Builder autoRollback(Boolean autoRollback)
(Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the
instance refresh fails or a CloudWatch alarm threshold is met. 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.
For more information, see Undo changes with a rollback in the Amazon EC2 Auto Scaling User Guide.
autoRollback - (Optional) Indicates whether to roll back the Auto Scaling group to its previous configuration if the
instance refresh fails or a CloudWatch alarm threshold is met. 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.
For more information, see Undo changes with a rollback in the Amazon EC2 Auto Scaling User Guide.
RefreshPreferences.Builder scaleInProtectedInstances(String scaleInProtectedInstances)
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:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
scaleInProtectedInstances - 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:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
ScaleInProtectedInstances,
ScaleInProtectedInstancesRefreshPreferences.Builder scaleInProtectedInstances(ScaleInProtectedInstances scaleInProtectedInstances)
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:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
scaleInProtectedInstances - 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:
Amazon EC2 Auto Scaling replaces instances that are protected from scale in.
Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.
Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.
ScaleInProtectedInstances,
ScaleInProtectedInstancesRefreshPreferences.Builder standbyInstances(String standbyInstances)
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:
Amazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances
that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
standbyInstances - 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:
Amazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace
instances that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
StandbyInstances,
StandbyInstancesRefreshPreferences.Builder standbyInstances(StandbyInstances standbyInstances)
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:
Amazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances
that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
standbyInstances - 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:
Amazon EC2 Auto Scaling terminates instances that are in Standby.
Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace
instances that are in the InService state.
Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.
StandbyInstances,
StandbyInstancesRefreshPreferences.Builder alarmSpecification(AlarmSpecification alarmSpecification)
(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met.
alarmSpecification - (Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues
and fail the operation if an alarm threshold is met.default RefreshPreferences.Builder alarmSpecification(Consumer<AlarmSpecification.Builder> alarmSpecification)
(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met.
This is a convenience method that creates an instance of theAlarmSpecification.Builder avoiding the
need to create one manually via AlarmSpecification.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to alarmSpecification(AlarmSpecification).
alarmSpecification - a consumer that will call methods on AlarmSpecification.BuilderalarmSpecification(AlarmSpecification)Copyright © 2023. All rights reserved.