com.amazonaws.services.autoscaling.model

Class RefreshPreferences

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

Method Summary

Modifier and Type	Method and Description
RefreshPreferences	clone()
boolean	equals(Object obj)
AlarmSpecification	getAlarmSpecification() (Optional) The CloudWatch alarm specification.
Boolean	getAutoRollback() (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.
Integer	getCheckpointDelay() (Optional) The amount of time, in seconds, to wait after a checkpoint before continuing.
List<Integer>	getCheckpointPercentages() (Optional) Threshold values for each checkpoint in ascending order.
Integer	getInstanceWarmup() 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.
Integer	getMaxHealthyPercentage() Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances.
Integer	getMinHealthyPercentage() Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue.
String	getScaleInProtectedInstances() Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
Boolean	getSkipMatching() (Optional) Indicates whether skip matching is enabled.
String	getStandbyInstances() Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found.
int	hashCode()
Boolean	isAutoRollback() (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.
Boolean	isSkipMatching() (Optional) Indicates whether skip matching is enabled.
void	setAlarmSpecification(AlarmSpecification alarmSpecification) (Optional) The CloudWatch alarm specification.
void	setAutoRollback(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.
void	setCheckpointDelay(Integer checkpointDelay) (Optional) The amount of time, in seconds, to wait after a checkpoint before continuing.
void	setCheckpointPercentages(Collection<Integer> checkpointPercentages) (Optional) Threshold values for each checkpoint in ascending order.
void	setInstanceWarmup(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.
void	setMaxHealthyPercentage(Integer maxHealthyPercentage) Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances.
void	setMinHealthyPercentage(Integer minHealthyPercentage) Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue.
void	setScaleInProtectedInstances(String scaleInProtectedInstances) Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
void	setSkipMatching(Boolean skipMatching) (Optional) Indicates whether skip matching is enabled.
void	setStandbyInstances(String standbyInstances) Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found.
String	toString() Returns a string representation of this object.
RefreshPreferences	withAlarmSpecification(AlarmSpecification alarmSpecification) (Optional) The CloudWatch alarm specification.
RefreshPreferences	withAutoRollback(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	withCheckpointDelay(Integer checkpointDelay) (Optional) The amount of time, in seconds, to wait after a checkpoint before continuing.
RefreshPreferences	withCheckpointPercentages(Collection<Integer> checkpointPercentages) (Optional) Threshold values for each checkpoint in ascending order.
RefreshPreferences	withCheckpointPercentages(Integer... checkpointPercentages) (Optional) Threshold values for each checkpoint in ascending order.
RefreshPreferences	withInstanceWarmup(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	withMaxHealthyPercentage(Integer maxHealthyPercentage) Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances.
RefreshPreferences	withMinHealthyPercentage(Integer minHealthyPercentage) Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue.
RefreshPreferences	withScaleInProtectedInstances(ScaleInProtectedInstances scaleInProtectedInstances) Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
RefreshPreferences	withScaleInProtectedInstances(String scaleInProtectedInstances) Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances protected from scale in are found.
RefreshPreferences	withSkipMatching(Boolean skipMatching) (Optional) Indicates whether skip matching is enabled.
RefreshPreferences	withStandbyInstances(StandbyInstances standbyInstances) Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found.
RefreshPreferences	withStandbyInstances(String standbyInstances) Choose the behavior that you want Amazon EC2 Auto Scaling to use if instances in Standby state are found.

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)

Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.

If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

Parameters:

minHealthyPercentage - Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.

If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

getMinHealthyPercentage

public Integer getMinHealthyPercentage()

Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.

If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

Returns:

Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.

If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

withMinHealthyPercentage

public RefreshPreferences withMinHealthyPercentage(Integer minHealthyPercentage)

Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.

If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

Parameters:

minHealthyPercentage - Specifies the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 0 to 100.

If you do not specify this property, the default is 90 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceWarmup

public void setInstanceWarmup(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.

Parameters:

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.

getInstanceWarmup

public Integer getInstanceWarmup()

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.

Returns:

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.

withInstanceWarmup

public RefreshPreferences withInstanceWarmup(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getCheckpointPercentages

public List<Integer> getCheckpointPercentages()

(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 Add checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Returns:

(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 Add checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

setCheckpointPercentages

public void setCheckpointPercentages(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 Add checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Parameters:

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 Add checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

withCheckpointPercentages

public RefreshPreferences withCheckpointPercentages(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 Add 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 - (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 Add 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)

(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 Add checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Parameters:

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

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

Parameters:

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

getCheckpointDelay

public Integer getCheckpointDelay()

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

Returns:

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

withCheckpointDelay

public RefreshPreferences withCheckpointDelay(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).

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setSkipMatching

public void setSkipMatching(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.

Parameters:

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.

getSkipMatching

public Boolean getSkipMatching()

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

Returns:

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

withSkipMatching

public RefreshPreferences withSkipMatching(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isSkipMatching

public Boolean isSkipMatching()

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

Returns:

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

setAutoRollback

public void setAutoRollback(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.

Parameters:

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.

getAutoRollback

public Boolean getAutoRollback()

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

Returns:

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

withAutoRollback

public RefreshPreferences withAutoRollback(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAutoRollback

public Boolean isAutoRollback()

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

Returns:

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

setScaleInProtectedInstances

public void setScaleInProtectedInstances(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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

Parameters:

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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

See Also:

ScaleInProtectedInstances

getScaleInProtectedInstances

public String getScaleInProtectedInstances()

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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

Returns:

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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

See Also:

ScaleInProtectedInstances

withScaleInProtectedInstances

public RefreshPreferences withScaleInProtectedInstances(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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

Parameters:

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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScaleInProtectedInstances

withScaleInProtectedInstances

public RefreshPreferences withScaleInProtectedInstances(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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

Parameters:

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:

Refresh

Amazon EC2 Auto Scaling replaces instances that are protected from scale in.

Ignore

Amazon EC2 Auto Scaling ignores instances that are protected from scale in and continues to replace instances that are not protected.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to remove scale-in protection. Otherwise, the instance refresh will fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ScaleInProtectedInstances

setStandbyInstances

public void setStandbyInstances(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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

Parameters:

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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

See Also:

StandbyInstances

getStandbyInstances

public String getStandbyInstances()

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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

Returns:

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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

See Also:

StandbyInstances

withStandbyInstances

public RefreshPreferences withStandbyInstances(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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

Parameters:

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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StandbyInstances

withStandbyInstances

public RefreshPreferences withStandbyInstances(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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

Parameters:

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:

Terminate

Amazon EC2 Auto Scaling terminates instances that are in Standby.

Ignore

Amazon EC2 Auto Scaling ignores instances that are in Standby and continues to replace instances that are in the InService state.

Wait (default)

Amazon EC2 Auto Scaling waits one hour for you to return the instances to service. Otherwise, the instance refresh will fail.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StandbyInstances

setAlarmSpecification

public void setAlarmSpecification(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.

Parameters:

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.

getAlarmSpecification

public AlarmSpecification getAlarmSpecification()

(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met.

Returns:

(Optional) The CloudWatch alarm specification. CloudWatch alarms can be used to identify any issues and fail the operation if an alarm threshold is met.

withAlarmSpecification

public RefreshPreferences withAlarmSpecification(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxHealthyPercentage

public void setMaxHealthyPercentage(Integer maxHealthyPercentage)

Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

Parameters:

maxHealthyPercentage - Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

getMaxHealthyPercentage

public Integer getMaxHealthyPercentage()

Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

Returns:

Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage , and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

withMaxHealthyPercentage

public RefreshPreferences withMaxHealthyPercentage(Integer maxHealthyPercentage)

Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

Parameters:

maxHealthyPercentage - Specifies the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. The value is expressed as a percentage of the desired capacity of the Auto Scaling group. Value range is 100 to 200.

If you specify MaxHealthyPercentage, you must also specify MinHealthyPercentage, and the difference between them cannot be greater than 100. A larger range increases the number of instances that can be replaced at the same time.

If you do not specify this property, the default is 100 percent, or the percentage set in the instance maintenance policy for the Auto Scaling group, if defined.

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