AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes an instance refresh for an Auto Scaling group.

Inheritance Hierarchy

System.Object
  Amazon.AutoScaling.Model.InstanceRefresh

Namespace: Amazon.AutoScaling.Model
Assembly: AWSSDK.AutoScaling.dll
Version: 3.x.y.z

Syntax

C# 
public class InstanceRefresh

The InstanceRefresh type exposes the following members

Constructors

NameDescription
Public Method InstanceRefresh()

Properties

NameTypeDescription
Public Property AutoScalingGroupName System.String

Gets and sets the property AutoScalingGroupName.

The name of the Auto Scaling group.

Public Property DesiredConfiguration Amazon.AutoScaling.Model.DesiredConfiguration

Gets and sets the property DesiredConfiguration.

Describes the desired configuration for the instance refresh.

Public Property EndTime System.DateTime

Gets and sets the property EndTime.

The date and time at which the instance refresh ended.

Public Property InstanceRefreshId System.String

Gets and sets the property InstanceRefreshId.

The instance refresh ID.

Public Property InstancesToUpdate System.Int32

Gets and sets the property 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.

Public Property PercentageComplete System.Int32

Gets and sets the property 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.

Public Property Preferences Amazon.AutoScaling.Model.RefreshPreferences

Gets and sets the property Preferences.

The preferences for an instance refresh.

Public Property ProgressDetails Amazon.AutoScaling.Model.InstanceRefreshProgressDetails

Gets and sets the property ProgressDetails.

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

Public Property RollbackDetails Amazon.AutoScaling.Model.RollbackDetails

Gets and sets the property RollbackDetails.

The rollback details.

Public Property StartTime System.DateTime

Gets and sets the property StartTime.

The date and time at which the instance refresh began.

Public Property Status Amazon.AutoScaling.InstanceRefreshStatus

Gets and sets the property 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.

Public Property StatusReason System.String

Gets and sets the property StatusReason.

The explanation for the specific status assigned to this operation.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5