Class InstanceRefresh
- java.lang.Object
-
- software.amazon.awssdk.services.autoscaling.model.InstanceRefresh
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<InstanceRefresh.Builder,InstanceRefresh>
@Generated("software.amazon.awssdk:codegen") public final class InstanceRefresh extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceRefresh.Builder,InstanceRefresh>
Describes an instance refresh for an Auto Scaling group.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
InstanceRefresh.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
autoScalingGroupName()
The name of the Auto Scaling group.static InstanceRefresh.Builder
builder()
DesiredConfiguration
desiredConfiguration()
Describes the desired configuration for the instance refresh.Instant
endTime()
The date and time at which the instance refresh ended.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
String
instanceRefreshId()
The instance refresh ID.Integer
instancesToUpdate()
The number of instances remaining to update before the instance refresh is complete.Integer
percentageComplete()
The percentage of the instance refresh that is complete.RefreshPreferences
preferences()
The preferences for an instance refresh.InstanceRefreshProgressDetails
progressDetails()
Additional progress details for an Auto Scaling group that has a warm pool.RollbackDetails
rollbackDetails()
The rollback details.List<SdkField<?>>
sdkFields()
static Class<? extends InstanceRefresh.Builder>
serializableBuilderClass()
Instant
startTime()
The date and time at which the instance refresh began.InstanceRefreshStatus
status()
The current status for the instance refresh operation:String
statusAsString()
The current status for the instance refresh operation:String
statusReason()
The explanation for the specific status assigned to this operation.InstanceRefresh.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
instanceRefreshId
public final String instanceRefreshId()
The instance refresh ID.
- Returns:
- The instance refresh ID.
-
autoScalingGroupName
public final String autoScalingGroupName()
The name of the Auto Scaling group.
- Returns:
- The name of the Auto Scaling group.
-
status
public final 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.
If the service returns an enum value that is not available in the current SDK version,
status
will returnInstanceRefreshStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
-
-
statusAsString
public final String statusAsString()
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.
If the service returns an enum value that is not available in the current SDK version,
status
will returnInstanceRefreshStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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
-
-
statusReason
public final String statusReason()
The explanation for the specific status assigned to this operation.
- Returns:
- The explanation for the specific status assigned to this operation.
-
startTime
public final Instant startTime()
The date and time at which the instance refresh began.
- Returns:
- The date and time at which the instance refresh began.
-
endTime
public final Instant endTime()
The date and time at which the instance refresh ended.
- Returns:
- The date and time at which the instance refresh ended.
-
percentageComplete
public final 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.- 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.
-
instancesToUpdate
public final 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.- 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.
-
progressDetails
public final InstanceRefreshProgressDetails progressDetails()
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.
-
preferences
public final RefreshPreferences preferences()
The preferences for an instance refresh.
- Returns:
- The preferences for an instance refresh.
-
desiredConfiguration
public final DesiredConfiguration desiredConfiguration()
Describes the desired configuration for the instance refresh.
- Returns:
- Describes the desired configuration for the instance refresh.
-
rollbackDetails
public final RollbackDetails rollbackDetails()
The rollback details.
- Returns:
- The rollback details.
-
toBuilder
public InstanceRefresh.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<InstanceRefresh.Builder,InstanceRefresh>
-
builder
public static InstanceRefresh.Builder builder()
-
serializableBuilderClass
public static Class<? extends InstanceRefresh.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
-