AWSAutoScalingInstanceRefresh

Objective-C

@interface AWSAutoScalingInstanceRefresh

Swift

class AWSAutoScalingInstanceRefresh

Describes an instance refresh for an Auto Scaling group.

  • The name of the Auto Scaling group.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable autoScalingGroupName;

    Swift

    var autoScalingGroupName: String? { get set }

  • Describes the desired configuration for the instance refresh.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingDesiredConfiguration *_Nullable desiredConfiguration;

    Swift

    var desiredConfiguration: AWSAutoScalingDesiredConfiguration? { get set }

  • The date and time at which the instance refresh ended.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable endTime;

    Swift

    var endTime: Date? { get set }

  • The instance refresh ID.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable instanceRefreshId;

    Swift

    var instanceRefreshId: String? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable instancesToUpdate;

    Swift

    var instancesToUpdate: NSNumber? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable percentageComplete;

    Swift

    var percentageComplete: NSNumber? { get set }

  • The preferences for an instance refresh.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingRefreshPreferences *_Nullable preferences;

    Swift

    var preferences: AWSAutoScalingRefreshPreferences? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingInstanceRefreshProgressDetails *_Nullable progressDetails;

    Swift

    var progressDetails: AWSAutoScalingInstanceRefreshProgressDetails? { get set }

  • The rollback details.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSAutoScalingRollbackDetails *_Nullable rollbackDetails;

    Swift

    var rollbackDetails: AWSAutoScalingRollbackDetails? { get set }

  • The date and time at which the instance refresh began.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSDate *_Nullable startTime;

    Swift

    var startTime: Date? { get set }

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

    Declaration

    Objective-C

    @property (nonatomic) AWSAutoScalingInstanceRefreshStatus status;

    Swift

    var status: AWSAutoScalingInstanceRefreshStatus { get set }

  • The explanation for the specific status assigned to this operation.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSString *_Nullable statusReason;

    Swift

    var statusReason: String? { get set }