Class: Aws::AutoScaling::Types::StartInstanceRefreshType

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::StartInstanceRefreshType

Includes:

Structure

Defined in:

lib/aws-sdk-autoscaling/types.rb

Overview

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

  The desired configuration.

• #preferences ⇒ Types::RefreshPreferences

  Sets your preferences for the instance refresh so that it performs as expected when you start it.

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

class StartInstanceRefreshType < Struct.new(
  :auto_scaling_group_name,
  :strategy,
  :desired_configuration,
  :preferences)
  SENSITIVE = []
  include Aws::Structure
end

#desired_configuration ⇒ Types::DesiredConfiguration

The desired configuration. For example, the desired configuration can specify a new launch template or a new version of the current launch template.

Once the instance refresh succeeds, Amazon EC2 Auto Scaling updates the settings of the Auto Scaling group to reflect the new desired configuration.

<note markdown=“1”> When you specify a new launch template or a new version of the current launch template for your desired configuration, consider enabling the ‘SkipMatching` property in preferences. If it’s enabled, Amazon EC2 Auto Scaling skips replacing instances that already use the specified launch template and instance types. This can help you reduce the number of replacements that are required to apply updates.

</note>

Returns:

• (Types::DesiredConfiguration)

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

class StartInstanceRefreshType < Struct.new(
  :auto_scaling_group_name,
  :strategy,
  :desired_configuration,
  :preferences)
  SENSITIVE = []
  include Aws::Structure
end

#preferences ⇒ Types::RefreshPreferences

Sets your preferences for the instance refresh so that it performs as expected when you start it. Includes the instance warmup time, the minimum and maximum healthy percentages, and the behaviors that you want Amazon EC2 Auto Scaling to use if instances that are in ‘Standby` state or protected from scale in are found. You can also choose to enable additional features, such as the following:

• Auto rollback

• Checkpoints

• CloudWatch alarms

• Skip matching

Returns:

• (Types::RefreshPreferences)

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

class StartInstanceRefreshType < Struct.new(
  :auto_scaling_group_name,
  :strategy,
  :desired_configuration,
  :preferences)
  SENSITIVE = []
  include Aws::Structure
end

#strategy ⇒ String

The strategy to use for the instance refresh. The only valid value is ‘Rolling`.

Returns:

• (String)

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

class StartInstanceRefreshType < Struct.new(
  :auto_scaling_group_name,
  :strategy,
  :desired_configuration,
  :preferences)
  SENSITIVE = []
  include Aws::Structure
end