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 the preferences for an instance refresh.

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() For responses, this returns true if the service returned a value for the CheckpointPercentages property.
int	hashCode()
Integer	instanceWarmup() Not needed if the default instance warmup is defined for the group.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends RefreshPreferences.Builder>	serializableBuilderClass()
Boolean	skipMatching() A boolean value that indicates whether skip matching is enabled.
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 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.

Returns:

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.

instanceWarmup

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

Returns:

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.

hasCheckpointPercentages

public final boolean hasCheckpointPercentages()

For responses, this returns true if the service returned a value for the CheckpointPercentages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

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.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCheckpointPercentages() method.

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

skipMatching

public final Boolean 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.

Returns:

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.

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