You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AutoScaling::Types::InstanceRefresh

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Describes an instance refresh for an Auto Scaling group.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

  • (String) —

    The name of the Auto Scaling group.

#end_time ⇒ Time

The date and time at which the instance refresh ended.

Returns:

  • (Time) —

    The date and time at which the instance refresh ended.

#instance_refresh_id ⇒ String

The instance refresh ID.

Returns:

  • (String) —

    The instance refresh ID.

#instances_to_update ⇒ Integer

The number of instances remaining to update before the instance refresh is complete.

Returns:

  • (Integer) —

    The number of instances remaining to update before the instance refresh is complete.

#percentage_complete ⇒ Integer

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 added to the percentage complete.

Returns:

  • (Integer) —

    The percentage of the instance refresh that is complete.

#start_time ⇒ Time

The date and time at which the instance refresh began.

Returns:

  • (Time) —

    The date and time at which the instance refresh began.

#status ⇒ String

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.

    Possible values:

    • Pending
    • InProgress
    • Successful
    • Failed
    • Cancelling
    • Cancelled

Returns:

  • (String) —

    The current status for the instance refresh operation:.

#status_reason ⇒ String

Provides more details about the current status of the instance refresh.

Returns:

  • (String) —

    Provides more details about the current status of the instance refresh.