InstanceRefresh (AWS Java SDK for Auto Scaling 1.12.383 API)

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 specific update you want to deploy.
`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()`
`InstanceRefreshProgressDetails`	`getProgressDetails()` Additional progress details for an Auto Scaling group that has a warm pool.
`Date`	`getStartTime()` The date and time at which the instance refresh began.
`String`	`getStatus()` The current status for the instance refresh operation:
`String`	`getStatusReason()` Provides more details about the current status of the instance refresh.
`int`	`hashCode()`
`void`	`setAutoScalingGroupName(String autoScalingGroupName)` The name of the Auto Scaling group.
`void`	`setDesiredConfiguration(DesiredConfiguration desiredConfiguration)` Describes the specific update you want to deploy.
`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)`
`void`	`setProgressDetails(InstanceRefreshProgressDetails progressDetails)` Additional progress details for an Auto Scaling group that has a warm pool.
`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)` Provides more details about the current status of the instance refresh.
`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 specific update you want to deploy.
`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)`
`InstanceRefresh`	`withProgressDetails(InstanceRefreshProgressDetails progressDetails)` Additional progress details for an Auto Scaling group that has a warm pool.
`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)` Provides more details about the current status of the instance refresh.

Methods inherited from class java.lang.Object
finalize, 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 operation has not started.
    - InProgress - The operation is in progress.
    - Successful - The operation completed successfully.
    - Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    - Cancelled - The operation is cancelled.
    Parameters:
    status - The current status for the instance refresh operation:
    
    Pending - The request was created, but the operation has not started.
    
    InProgress - The operation is in progress.
    
    Successful - The operation completed successfully.
    
    Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    
    Cancelled - The operation is cancelled.
    See Also:
    
    InstanceRefreshStatus
  - getStatus
```
public String getStatus()
```
    The current status for the instance refresh operation:
    - Pending - The request was created, but the operation has not started.
    - InProgress - The operation is in progress.
    - Successful - The operation completed successfully.
    - Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    - Cancelled - The operation is cancelled.
    Returns:
    The current status for the instance refresh operation:
    
    Pending - The request was created, but the operation has not started.
    
    InProgress - The operation is in progress.
    
    Successful - The operation completed successfully.
    
    Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    
    Cancelled - The operation is cancelled.
    See Also:
    
    InstanceRefreshStatus
  - withStatus
```
public InstanceRefresh withStatus(String status)
```
    The current status for the instance refresh operation:
    - Pending - The request was created, but the operation has not started.
    - InProgress - The operation is in progress.
    - Successful - The operation completed successfully.
    - Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    - Cancelled - The operation is cancelled.
    Parameters:
    status - The current status for the instance refresh operation:
    
    Pending - The request was created, but the operation has not started.
    
    InProgress - The operation is in progress.
    
    Successful - The operation completed successfully.
    
    Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    
    Cancelled - The operation is cancelled.
    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 operation has not started.
    - InProgress - The operation is in progress.
    - Successful - The operation completed successfully.
    - Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    - Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    - Cancelled - The operation is cancelled.
    Parameters:
    status - The current status for the instance refresh operation:
    
    Pending - The request was created, but the operation has not started.
    
    InProgress - The operation is in progress.
    
    Successful - The operation completed successfully.
    
    Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
    
    Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.
    
    Cancelled - The operation is cancelled.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceRefreshStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    Provides more details about the current status of the instance refresh.
    
    Parameters:
    
    statusReason - Provides more details about the current status of the instance refresh.
  - getStatusReason
```
public String getStatusReason()
```
    Provides more details about the current status of the instance refresh.
    
    Returns:
    
    Provides more details about the current status of the instance refresh.
  - withStatusReason
```
public InstanceRefresh withStatusReason(String statusReason)
```
    Provides more details about the current status of the instance refresh.
    
    Parameters:
    
    statusReason - Provides more details about the current status of the instance refresh.
    
    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.
    
    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.
  - 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.
    
    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.
  - 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.
    
    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.
    
    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.
    
    Parameters:
    
    instancesToUpdate - The number of instances remaining to update before the instance refresh is complete.
  - getInstancesToUpdate
```
public Integer getInstancesToUpdate()
```
    The number of instances remaining to update before the instance refresh is complete.
    
    Returns:
    
    The number of instances remaining to update before the instance refresh is complete.
  - withInstancesToUpdate
```
public InstanceRefresh withInstancesToUpdate(Integer instancesToUpdate)
```
    The number of instances remaining to update before the instance refresh is complete.
    
    Parameters:
    
    instancesToUpdate - The number of instances remaining to update before the instance refresh is complete.
    
    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)
```
    Parameters:
    
    preferences -
  - getPreferences
```
public RefreshPreferences getPreferences()
```
    Returns:
  - withPreferences
```
public InstanceRefresh withPreferences(RefreshPreferences preferences)
```
    Parameters:
    
    preferences -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDesiredConfiguration
```
public void setDesiredConfiguration(DesiredConfiguration desiredConfiguration)
```
    Describes the specific update you want to deploy.
    
    Parameters:
    
    desiredConfiguration - Describes the specific update you want to deploy.
  - getDesiredConfiguration
```
public DesiredConfiguration getDesiredConfiguration()
```
    Describes the specific update you want to deploy.
    
    Returns:
    
    Describes the specific update you want to deploy.
  - withDesiredConfiguration
```
public InstanceRefresh withDesiredConfiguration(DesiredConfiguration desiredConfiguration)
```
    Describes the specific update you want to deploy.
    
    Parameters:
    
    desiredConfiguration - Describes the specific update you want to deploy.
    
    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

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

toString

equals

hashCode

clone