RefreshPreferences (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.autoscaling.model.RefreshPreferences

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RefreshPreferences
extends Object
implements Serializable, Cloneable
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

RefreshPreferences()

Constructors
Constructor and Description
`RefreshPreferences()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`RefreshPreferences`	`clone()`
`boolean`	`equals(Object obj)`
`Integer`	`getCheckpointDelay()` The amount of time, in seconds, to wait after a checkpoint before continuing.
`List<Integer>`	`getCheckpointPercentages()` Threshold values for each checkpoint in ascending order.
`Integer`	`getInstanceWarmup()` The number of seconds until a newly launched instance is configured and ready to use.
`Integer`	`getMinHealthyPercentage()` 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).
`int`	`hashCode()`
`void`	`setCheckpointDelay(Integer checkpointDelay)` The amount of time, in seconds, to wait after a checkpoint before continuing.
`void`	`setCheckpointPercentages(Collection<Integer> checkpointPercentages)` Threshold values for each checkpoint in ascending order.
`void`	`setInstanceWarmup(Integer instanceWarmup)` The number of seconds until a newly launched instance is configured and ready to use.
`void`	`setMinHealthyPercentage(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).
`String`	`toString()` Returns a string representation of this object.
`RefreshPreferences`	`withCheckpointDelay(Integer checkpointDelay)` The amount of time, in seconds, to wait after a checkpoint before continuing.
`RefreshPreferences`	`withCheckpointPercentages(Collection<Integer> checkpointPercentages)` Threshold values for each checkpoint in ascending order.
`RefreshPreferences`	`withCheckpointPercentages(Integer... checkpointPercentages)` Threshold values for each checkpoint in ascending order.
`RefreshPreferences`	`withInstanceWarmup(Integer instanceWarmup)` The number of seconds until a newly launched instance is configured and ready to use.
`RefreshPreferences`	`withMinHealthyPercentage(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).

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - RefreshPreferences
```
public RefreshPreferences()
```
- Method Detail
  - setMinHealthyPercentage
```
public void setMinHealthyPercentage(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.
    
    Parameters:
    
    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.
  - getMinHealthyPercentage
```
public Integer getMinHealthyPercentage()
```
    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.
  - withMinHealthyPercentage
```
public RefreshPreferences withMinHealthyPercentage(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceWarmup
```
public void setInstanceWarmup(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.
    
    Parameters:
    
    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.
  - getInstanceWarmup
```
public Integer getInstanceWarmup()
```
    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.
  - withInstanceWarmup
```
public RefreshPreferences withInstanceWarmup(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getCheckpointPercentages
```
public List<Integer> getCheckpointPercentages()
```
    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.
    
    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.
  - setCheckpointPercentages
```
public void setCheckpointPercentages(Collection<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.
    
    Parameters:
    
    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.
  - withCheckpointPercentages
```
public RefreshPreferences withCheckpointPercentages(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setCheckpointPercentages(java.util.Collection) or withCheckpointPercentages(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withCheckpointPercentages
```
public RefreshPreferences withCheckpointPercentages(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCheckpointDelay
```
public void setCheckpointDelay(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).
    
    Parameters:
    
    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).
  - getCheckpointDelay
```
public Integer getCheckpointDelay()
```
    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).
  - withCheckpointDelay
```
public RefreshPreferences withCheckpointDelay(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).
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public RefreshPreferences clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class RefreshPreferences

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RefreshPreferences

Method Detail

setMinHealthyPercentage

getMinHealthyPercentage

withMinHealthyPercentage

setInstanceWarmup

getInstanceWarmup

withInstanceWarmup

getCheckpointPercentages

setCheckpointPercentages

withCheckpointPercentages

withCheckpointPercentages

setCheckpointDelay

getCheckpointDelay

withCheckpointDelay

toString

equals

hashCode

clone