InstanceRefresh - Amazon EC2 Auto Scaling
ContentsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

InstanceRefresh

Describes an instance refresh for an Auto Scaling group.

Contents

AutoScalingGroupName

The name of the Auto Scaling group.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

DesiredConfiguration

Describes the desired configuration for the instance refresh.

Type: DesiredConfiguration object

Required: No

EndTime

The date and time at which the instance refresh ended.

Type: Timestamp

Required: No

InstanceRefreshId

The instance refresh ID.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

InstancesToUpdate

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

Note

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.

Type: Integer

Valid Range: Minimum value of 0.

Required: No

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.

Note

PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

Preferences

The preferences for an instance refresh.

Type: RefreshPreferences object

Required: No

ProgressDetails

Additional progress details for an Auto Scaling group that has a warm pool.

Type: InstanceRefreshProgressDetails object

Required: No

RollbackDetails

The rollback details.

Type: RollbackDetails object

Required: No

StartTime

The date and time at which the instance refresh began.

Type: Timestamp

Required: No

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.

Type: String

Valid Values: Pending | InProgress | Successful | Failed | Cancelling | Cancelled | RollbackInProgress | RollbackFailed | RollbackSuccessful

Required: No

StatusReason

The explanation for the specific status assigned to this operation.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1023.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: