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

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::InstanceRefresh

Includes:

Structure

Defined in:

lib/aws-sdk-autoscaling/types.rb

Overview

Describes an instance refresh for an Auto Scaling group.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_scaling_group_name ⇒ String

  The name of the Auto Scaling group.

• #desired_configuration ⇒ Types::DesiredConfiguration

  Describes the desired configuration for the instance refresh.

• #end_time ⇒ Time

  The date and time at which the instance refresh ended.

• #instance_refresh_id ⇒ String

  The instance refresh ID.

• #instances_to_update ⇒ Integer

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

• #percentage_complete ⇒ Integer

  The percentage of the instance refresh that is complete.

• #preferences ⇒ Types::RefreshPreferences

  The preferences for an instance refresh.

• #progress_details ⇒ Types::InstanceRefreshProgressDetails

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

• #rollback_details ⇒ Types::RollbackDetails

  The rollback details.

• #start_time ⇒ Time

  The date and time at which the instance refresh began.

• #status ⇒ String

  The current status for the instance refresh operation:.

• #status_reason ⇒ String

  The explanation for the specific status assigned to this operation.

• #strategy ⇒ String

  The strategy to use for the instance refresh.

Instance Attribute Details

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#desired_configuration ⇒ Types::DesiredConfiguration

Describes the desired configuration for the instance refresh.

Returns:

• (Types::DesiredConfiguration)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The date and time at which the instance refresh ended.

Returns:

• (Time)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#instance_refresh_id ⇒ String

The instance refresh ID.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#instances_to_update ⇒ Integer

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

<note markdown=“1”> 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.

</note>

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  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.

<note markdown=“1”> PercentageComplete does not include instances that are replaced during a rollback. This value gradually goes back down to zero during a rollback.

</note>

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#preferences ⇒ Types::RefreshPreferences

The preferences for an instance refresh.

Returns:

• (Types::RefreshPreferences)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#progress_details ⇒ Types::InstanceRefreshProgressDetails

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

Returns:

• (Types::InstanceRefreshProgressDetails)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#rollback_details ⇒ Types::RollbackDetails

The rollback details.

Returns:

• (Types::RollbackDetails)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time at which the instance refresh began.

Returns:

• (Time)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  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.

• Baking - Waiting the specified bake time after an instance refresh has finished updating instances.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#status_reason ⇒ String

The explanation for the specific status assigned to this operation.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end

#strategy ⇒ String

The strategy to use for the instance refresh. This determines how instances in the Auto Scaling group are updated. Default is Rolling.

• Rolling – Terminates instances and launches replacements in batches

• ReplaceRootVolume – Updates instances by replacing only the root volume without terminating the instance

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3933

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,
  :strategy)
  SENSITIVE = []
  include Aws::Structure
end