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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-autoscaling/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 specific update you want to deploy.

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

  Describes the preferences for an instance refresh.

• #progress_details ⇒ Types::InstanceRefreshProgressDetails

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

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

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

Instance Attribute Details

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

• (String)

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

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

#desired_configuration ⇒ Types::DesiredConfiguration

Describes the specific update you want to deploy.

Returns:

• (Types::DesiredConfiguration)

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

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

#end_time ⇒ Time

The date and time at which the instance refresh ended.

Returns:

• (Time)

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

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

#instance_refresh_id ⇒ String

The instance refresh ID.

Returns:

• (String)

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

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

#instances_to_update ⇒ Integer

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

Returns:

• (Integer)

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

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

Returns:

• (Integer)

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

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

#preferences ⇒ Types::RefreshPreferences

Describes the preferences for an instance refresh.

Returns:

• (Types::RefreshPreferences)

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

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)
  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 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3329

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

#start_time ⇒ Time

The date and time at which the instance refresh began.

Returns:

• (Time)

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

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

#status ⇒ String

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.

Returns:

• (String)

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

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

#status_reason ⇒ String

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

Returns:

• (String)

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

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