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

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()` Not needed if the default instance warmup is defined for the group.
`Integer`	`getMinHealthyPercentage()` The amount of capacity in the Auto Scaling group that must pass your group's health checks to allow the operation to continue.
`Boolean`	`getSkipMatching()` A boolean value that indicates whether skip matching is enabled.
`int`	`hashCode()`
`Boolean`	`isSkipMatching()` A boolean value that indicates whether skip matching is enabled.
`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)` Not needed if the default instance warmup is defined for the group.
`void`	`setMinHealthyPercentage(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.
`void`	`setSkipMatching(Boolean skipMatching)` A boolean value that indicates whether skip matching is enabled.
`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)` Not needed if the default instance warmup is defined for the group.
`RefreshPreferences`	`withMinHealthyPercentage(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`	`withSkipMatching(Boolean skipMatching)` A boolean value that indicates whether skip matching is enabled.

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 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.
    
    Parameters:
    
    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.
  - getMinHealthyPercentage
```
public Integer getMinHealthyPercentage()
```
    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.
  - withMinHealthyPercentage
```
public RefreshPreferences withMinHealthyPercentage(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceWarmup
```
public void setInstanceWarmup(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.
    
    Parameters:
    
    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.
  - getInstanceWarmup
```
public Integer getInstanceWarmup()
```
    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.
  - withInstanceWarmup
```
public RefreshPreferences withInstanceWarmup(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.
    
    Parameters:
    
    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:
    
    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.
  - setSkipMatching
```
public void setSkipMatching(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.
    
    Parameters:
    
    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.
  - getSkipMatching
```
public Boolean getSkipMatching()
```
    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.
  - withSkipMatching
```
public RefreshPreferences withSkipMatching(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isSkipMatching
```
public Boolean isSkipMatching()
```
    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.
  - 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

setSkipMatching

getSkipMatching

withSkipMatching

isSkipMatching

toString

equals

hashCode

clone