software.amazon.awssdk.services.autoscaling.model

Class RefreshPreferences

java.lang.Object

software.amazon.awssdk.services.autoscaling.model.RefreshPreferences

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RefreshPreferences.Builder,RefreshPreferences>

@Generated(value="software.amazon.awssdk:codegen")
public final class RefreshPreferences
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RefreshPreferences.Builder,RefreshPreferences>

Describes information used to start an instance refresh.

All properties are optional. However, if you specify a value for CheckpointDelay, you must also provide a value for CheckpointPercentages.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RefreshPreferences.Builder

Method Summary

Modifier and Type	Method and Description
static RefreshPreferences.Builder	builder()
Integer	checkpointDelay() The amount of time, in seconds, to wait after a checkpoint before continuing.
List<Integer>	checkpointPercentages() Threshold values for each checkpoint in ascending order.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCheckpointPercentages() Returns true if the CheckpointPercentages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Integer	instanceWarmup() The number of seconds until a newly launched instance is configured and ready to use.
Integer	minHealthyPercentage() The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue, as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer).
List<SdkField<?>>	sdkFields()
static Class<? extends RefreshPreferences.Builder>	serializableBuilderClass()
RefreshPreferences.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

minHealthyPercentage

public final Integer minHealthyPercentage()

The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue, as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

Returns:

The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue, as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

instanceWarmup

public final Integer instanceWarmup()

The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.

Returns:

The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.

hasCheckpointPercentages

public final boolean hasCheckpointPercentages()

Returns true if the CheckpointPercentages property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

checkpointPercentages

public final List<Integer> 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasCheckpointPercentages() to see if a value was sent in this field.

Returns:

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.

checkpointDelay

public final Integer 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).

Returns:

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).

toBuilder

public RefreshPreferences.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RefreshPreferences.Builder,RefreshPreferences>

builder

public static RefreshPreferences.Builder builder()

serializableBuilderClass

public static Class<? extends RefreshPreferences.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo