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:

  • Method Details

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

      • Baking - Waiting the specified bake time after an instance refresh has finished updating instances.

      If the service returns an enum value that is not available in the current SDK version, status will return InstanceRefreshStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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.

      • Baking - Waiting the specified bake time after an instance refresh has finished updating instances.

      See Also:

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

      • Baking - Waiting the specified bake time after an instance refresh has finished updating instances.

      If the service returns an enum value that is not available in the current SDK version, status will return InstanceRefreshStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      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.

      • Baking - Waiting the specified bake time after an instance refresh has finished updating instances.

      See Also:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<InstanceRefresh.Builder,InstanceRefresh>
      Returns:
      a builder for type T

    • builder

      public static InstanceRefresh.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InstanceRefresh.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.