InstanceRefresh (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InstanceRefresh
extends Object
implements Serializable, Cloneable
```
Describes an instance refresh for an Auto Scaling group.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InstanceRefresh()

Constructors
Constructor and Description
`InstanceRefresh()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstanceRefresh`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAutoScalingGroupName()` The name of the Auto Scaling group.
`DesiredConfiguration`	`getDesiredConfiguration()` Describes the desired configuration for the instance refresh.
`Date`	`getEndTime()` The date and time at which the instance refresh ended.
`String`	`getInstanceRefreshId()` The instance refresh ID.
`Integer`	`getInstancesToUpdate()` The number of instances remaining to update before the instance refresh is complete.
`Integer`	`getPercentageComplete()` The percentage of the instance refresh that is complete.
`RefreshPreferences`	`getPreferences()` The preferences for an instance refresh.
`InstanceRefreshProgressDetails`	`getProgressDetails()` Additional progress details for an Auto Scaling group that has a warm pool.
`RollbackDetails`	`getRollbackDetails()` The rollback details.
`Date`	`getStartTime()` The date and time at which the instance refresh began.
`String`	`getStatus()` The current status for the instance refresh operation:
`String`	`getStatusReason()` The explanation for the specific status assigned to this operation.
`int`	`hashCode()`
`void`	`setAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`void`	`setDesiredConfiguration(DesiredConfiguration desiredConfiguration)` Describes the desired configuration for the instance refresh.
`void`	`setEndTime(Date endTime)` The date and time at which the instance refresh ended.
`void`	`setInstanceRefreshId(String instanceRefreshId)` The instance refresh ID.
`void`	`setInstancesToUpdate(Integer instancesToUpdate)` The number of instances remaining to update before the instance refresh is complete.
`void`	`setPercentageComplete(Integer percentageComplete)` The percentage of the instance refresh that is complete.
`void`	`setPreferences(RefreshPreferences preferences)` The preferences for an instance refresh.
`void`	`setProgressDetails(InstanceRefreshProgressDetails progressDetails)` Additional progress details for an Auto Scaling group that has a warm pool.
`void`	`setRollbackDetails(RollbackDetails rollbackDetails)` The rollback details.
`void`	`setStartTime(Date startTime)` The date and time at which the instance refresh began.
`void`	`setStatus(String status)` The current status for the instance refresh operation:
`void`	`setStatusReason(String statusReason)` The explanation for the specific status assigned to this operation.
`String`	`toString()` Returns a string representation of this object.
`InstanceRefresh`	`withAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`InstanceRefresh`	`withDesiredConfiguration(DesiredConfiguration desiredConfiguration)` Describes the desired configuration for the instance refresh.
`InstanceRefresh`	`withEndTime(Date endTime)` The date and time at which the instance refresh ended.
`InstanceRefresh`	`withInstanceRefreshId(String instanceRefreshId)` The instance refresh ID.
`InstanceRefresh`	`withInstancesToUpdate(Integer instancesToUpdate)` The number of instances remaining to update before the instance refresh is complete.
`InstanceRefresh`	`withPercentageComplete(Integer percentageComplete)` The percentage of the instance refresh that is complete.
`InstanceRefresh`	`withPreferences(RefreshPreferences preferences)` The preferences for an instance refresh.
`InstanceRefresh`	`withProgressDetails(InstanceRefreshProgressDetails progressDetails)` Additional progress details for an Auto Scaling group that has a warm pool.
`InstanceRefresh`	`withRollbackDetails(RollbackDetails rollbackDetails)` The rollback details.
`InstanceRefresh`	`withStartTime(Date startTime)` The date and time at which the instance refresh began.
`InstanceRefresh`	`withStatus(InstanceRefreshStatus status)` The current status for the instance refresh operation:
`InstanceRefresh`	`withStatus(String status)` The current status for the instance refresh operation:
`InstanceRefresh`	`withStatusReason(String statusReason)` The explanation for the specific status assigned to this operation.

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

- Constructor Detail
  - InstanceRefresh
```
public InstanceRefresh()
```
- Method Detail
  - setInstanceRefreshId
```
public void setInstanceRefreshId(String instanceRefreshId)
```
    The instance refresh ID.
    
    Parameters:
    
    instanceRefreshId - The instance refresh ID.
  - getInstanceRefreshId
```
public String getInstanceRefreshId()
```
    The instance refresh ID.
    
    Returns:
    
    The instance refresh ID.
  - withInstanceRefreshId
```
public InstanceRefresh withInstanceRefreshId(String instanceRefreshId)
```
    The instance refresh ID.
    
    Parameters:
    
    instanceRefreshId - The instance refresh ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoScalingGroupName
```
public void setAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group.
  - getAutoScalingGroupName
```
public String getAutoScalingGroupName()
```
    The name of the Auto Scaling group.
    
    Returns:
    
    The name of the Auto Scaling group.
  - withAutoScalingGroupName
```
public InstanceRefresh withAutoScalingGroupName(String autoScalingGroupName)
```
    The name of the Auto Scaling group.
    
    Parameters:
    
    autoScalingGroupName - The name of the Auto Scaling group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    The current status for the instance refresh operation:
    - Pending - The request was created, but the instance refresh has not started.
    - InProgress - An instance refresh is in progress.
    - Successful - An instance refresh completed successfully.
    - Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing instance refresh is being cancelled.
    - Cancelled - The instance refresh is cancelled.
    - RollbackInProgress - An instance refresh is being rolled back.
    - RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - RollbackSuccessful - The rollback completed successfully.
    Parameters:
    status - The current status for the instance refresh operation:
    
    Pending - The request was created, but the instance refresh has not started.
    
    InProgress - An instance refresh is in progress.
    
    Successful - An instance refresh completed successfully.
    
    Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing instance refresh is being cancelled.
    
    Cancelled - The instance refresh is cancelled.
    
    RollbackInProgress - An instance refresh is being rolled back.
    
    RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    RollbackSuccessful - The rollback completed successfully.
    See Also:
    
    InstanceRefreshStatus
  - getStatus
```
public String getStatus()
```
    The current status for the instance refresh operation:
    - Pending - The request was created, but the instance refresh has not started.
    - InProgress - An instance refresh is in progress.
    - Successful - An instance refresh completed successfully.
    - Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing instance refresh is being cancelled.
    - Cancelled - The instance refresh is cancelled.
    - RollbackInProgress - An instance refresh is being rolled back.
    - RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - RollbackSuccessful - The rollback completed successfully.
    Returns:
    The current status for the instance refresh operation:
    
    Pending - The request was created, but the instance refresh has not started.
    
    InProgress - An instance refresh is in progress.
    
    Successful - An instance refresh completed successfully.
    
    Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing instance refresh is being cancelled.
    
    Cancelled - The instance refresh is cancelled.
    
    RollbackInProgress - An instance refresh is being rolled back.
    
    RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    RollbackSuccessful - The rollback completed successfully.
    See Also:
    
    InstanceRefreshStatus
  - withStatus
```
public InstanceRefresh withStatus(String status)
```
    The current status for the instance refresh operation:
    - Pending - The request was created, but the instance refresh has not started.
    - InProgress - An instance refresh is in progress.
    - Successful - An instance refresh completed successfully.
    - Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing instance refresh is being cancelled.
    - Cancelled - The instance refresh is cancelled.
    - RollbackInProgress - An instance refresh is being rolled back.
    - RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - RollbackSuccessful - The rollback completed successfully.
    Parameters:
    status - The current status for the instance refresh operation:
    
    Pending - The request was created, but the instance refresh has not started.
    
    InProgress - An instance refresh is in progress.
    
    Successful - An instance refresh completed successfully.
    
    Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing instance refresh is being cancelled.
    
    Cancelled - The instance refresh is cancelled.
    
    RollbackInProgress - An instance refresh is being rolled back.
    
    RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    RollbackSuccessful - The rollback completed successfully.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceRefreshStatus
  - withStatus
```
public InstanceRefresh withStatus(InstanceRefreshStatus status)
```
    The current status for the instance refresh operation:
    - Pending - The request was created, but the instance refresh has not started.
    - InProgress - An instance refresh is in progress.
    - Successful - An instance refresh completed successfully.
    - Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing instance refresh is being cancelled.
    - Cancelled - The instance refresh is cancelled.
    - RollbackInProgress - An instance refresh is being rolled back.
    - RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - RollbackSuccessful - The rollback completed successfully.
    Parameters:
    status - The current status for the instance refresh operation:
    
    Pending - The request was created, but the instance refresh has not started.
    
    InProgress - An instance refresh is in progress.
    
    Successful - An instance refresh completed successfully.
    
    Failed - An instance refresh failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing instance refresh is being cancelled.
    
    Cancelled - The instance refresh is cancelled.
    
    RollbackInProgress - An instance refresh is being rolled back.
    
    RollbackFailed - The rollback failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    RollbackSuccessful - The rollback completed successfully.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceRefreshStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The explanation for the specific status assigned to this operation.
    
    Parameters:
    
    statusReason - The explanation for the specific status assigned to this operation.
  - getStatusReason
```
public String getStatusReason()
```
    The explanation for the specific status assigned to this operation.
    
    Returns:
    
    The explanation for the specific status assigned to this operation.
  - withStatusReason
```
public InstanceRefresh withStatusReason(String statusReason)
```
    The explanation for the specific status assigned to this operation.
    
    Parameters:
    
    statusReason - The explanation for the specific status assigned to this operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The date and time at which the instance refresh began.
    
    Parameters:
    
    startTime - The date and time at which the instance refresh began.
  - getStartTime
```
public Date getStartTime()
```
    The date and time at which the instance refresh began.
    
    Returns:
    
    The date and time at which the instance refresh began.
  - withStartTime
```
public InstanceRefresh withStartTime(Date startTime)
```
    The date and time at which the instance refresh began.
    
    Parameters:
    
    startTime - The date and time at which the instance refresh began.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The date and time at which the instance refresh ended.
    
    Parameters:
    
    endTime - The date and time at which the instance refresh ended.
  - getEndTime
```
public Date getEndTime()
```
    The date and time at which the instance refresh ended.
    
    Returns:
    
    The date and time at which the instance refresh ended.
  - withEndTime
```
public InstanceRefresh withEndTime(Date endTime)
```
    The date and time at which the instance refresh ended.
    
    Parameters:
    
    endTime - The date and time at which the instance refresh ended.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPercentageComplete
```
public void setPercentageComplete(Integer percentageComplete)
```
    The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
    
    PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
    
    Parameters:
    
    percentageComplete - The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
    
    PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
  - getPercentageComplete
```
public Integer getPercentageComplete()
```
    The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
    
    PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
    
    Returns:
    
    The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
    
    PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
  - withPercentageComplete
```
public InstanceRefresh withPercentageComplete(Integer percentageComplete)
```
    The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
    
    PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
    
    Parameters:
    
    percentageComplete - The percentage of the instance refresh that is complete. For each instance replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the instance's health status changes to healthy and the specified warm-up time passes, the instance is considered updated and is added to the percentage complete.
    
    PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstancesToUpdate
```
public void setInstancesToUpdate(Integer instancesToUpdate)
```
    The number of instances remaining to update before the instance refresh is complete.
    
    If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
    
    Parameters:
    
    instancesToUpdate - The number of instances remaining to update before the instance refresh is complete.
    
    If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
  - getInstancesToUpdate
```
public Integer getInstancesToUpdate()
```
    The number of instances remaining to update before the instance refresh is complete.
    
    If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
    
    Returns:
    
    The number of instances remaining to update before the instance refresh is complete.
    
    If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
  - withInstancesToUpdate
```
public InstanceRefresh withInstancesToUpdate(Integer instancesToUpdate)
```
    The number of instances remaining to update before the instance refresh is complete.
    
    If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
    
    Parameters:
    
    instancesToUpdate - The number of instances remaining to update before the instance refresh is complete.
    
    If you roll back the instance refresh, InstancesToUpdate shows you the number of instances that were not yet updated by the instance refresh. Therefore, these instances don't need to be replaced as part of the rollback.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProgressDetails
```
public void setProgressDetails(InstanceRefreshProgressDetails progressDetails)
```
    Additional progress details for an Auto Scaling group that has a warm pool.
    
    Parameters:
    
    progressDetails - Additional progress details for an Auto Scaling group that has a warm pool.
  - getProgressDetails
```
public InstanceRefreshProgressDetails getProgressDetails()
```
    Additional progress details for an Auto Scaling group that has a warm pool.
    
    Returns:
    
    Additional progress details for an Auto Scaling group that has a warm pool.
  - withProgressDetails
```
public InstanceRefresh withProgressDetails(InstanceRefreshProgressDetails progressDetails)
```
    Additional progress details for an Auto Scaling group that has a warm pool.
    
    Parameters:
    
    progressDetails - Additional progress details for an Auto Scaling group that has a warm pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreferences
```
public void setPreferences(RefreshPreferences preferences)
```
    The preferences for an instance refresh.
    
    Parameters:
    
    preferences - The preferences for an instance refresh.
  - getPreferences
```
public RefreshPreferences getPreferences()
```
    The preferences for an instance refresh.
    
    Returns:
    
    The preferences for an instance refresh.
  - withPreferences
```
public InstanceRefresh withPreferences(RefreshPreferences preferences)
```
    The preferences for an instance refresh.
    
    Parameters:
    
    preferences - The preferences for an instance refresh.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredConfiguration
```
public void setDesiredConfiguration(DesiredConfiguration desiredConfiguration)
```
    Describes the desired configuration for the instance refresh.
    
    Parameters:
    
    desiredConfiguration - Describes the desired configuration for the instance refresh.
  - getDesiredConfiguration
```
public DesiredConfiguration getDesiredConfiguration()
```
    Describes the desired configuration for the instance refresh.
    
    Returns:
    
    Describes the desired configuration for the instance refresh.
  - withDesiredConfiguration
```
public InstanceRefresh withDesiredConfiguration(DesiredConfiguration desiredConfiguration)
```
    Describes the desired configuration for the instance refresh.
    
    Parameters:
    
    desiredConfiguration - Describes the desired configuration for the instance refresh.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRollbackDetails
```
public void setRollbackDetails(RollbackDetails rollbackDetails)
```
    The rollback details.
    
    Parameters:
    
    rollbackDetails - The rollback details.
  - getRollbackDetails
```
public RollbackDetails getRollbackDetails()
```
    The rollback details.
    
    Returns:
    
    The rollback details.
  - withRollbackDetails
```
public InstanceRefresh withRollbackDetails(RollbackDetails rollbackDetails)
```
    The rollback details.
    
    Parameters:
    
    rollbackDetails - The rollback details.
    
    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 InstanceRefresh clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class InstanceRefresh

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InstanceRefresh

Method Detail

setInstanceRefreshId

getInstanceRefreshId

withInstanceRefreshId

setAutoScalingGroupName

getAutoScalingGroupName

withAutoScalingGroupName

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setPercentageComplete

getPercentageComplete

withPercentageComplete

setInstancesToUpdate

getInstancesToUpdate

withInstancesToUpdate

setProgressDetails

getProgressDetails

withProgressDetails

setPreferences

getPreferences

withPreferences

setDesiredConfiguration

getDesiredConfiguration

withDesiredConfiguration

setRollbackDetails

getRollbackDetails

withRollbackDetails

toString

equals

hashCode

clone