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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Describes an instance refresh for an Auto Scaling group.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

  • (String) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#desired_configuration ⇒ Types::DesiredConfiguration

Describes the desired configuration for the instance refresh.

Returns:



3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The date and time at which the instance refresh ended.

Returns:

  • (Time) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#instance_refresh_id ⇒ String

The instance refresh ID.

Returns:

  • (String) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#instances_to_update ⇒ Integer

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.

Returns:

  • (Integer) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (Integer) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#preferences ⇒ Types::RefreshPreferences

The preferences for an instance refresh.

Returns:



3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#progress_details ⇒ Types::InstanceRefreshProgressDetails

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

Returns:



3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_details ⇒ Types::RollbackDetails

The rollback details.

Returns:



3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time at which the instance refresh began.

Returns:

  • (Time) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

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.

Returns:

  • (String) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The explanation for the specific status assigned to this operation.

Returns:

  • (String) 


3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
 
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3406

class InstanceRefresh < Struct.new(
  :instance_refresh_id,
  :auto_scaling_group_name,
  :status,
  :status_reason,
  :start_time,
  :end_time,
  :percentage_complete,
  :instances_to_update,
  :progress_details,
  :preferences,
  :desired_configuration,
  :rollback_details)
  SENSITIVE = []
  include Aws::Structure
end