InstanceRefresh - Amazon EC2 Auto Scaling

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 specific update you want to deploy.

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.

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.

Type: Integer

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

Required: No

Preferences

Describes 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

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

Type: String

Valid Values: Pending | InProgress | Successful | Failed | Cancelling | Cancelled

Required: No

StatusReason

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

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 AWS SDKs, see the following: