Class: Aws::AutoScaling::Types::RefreshPreferences

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::RefreshPreferences

Defined in:

gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass RefreshPreferences data as a hash:

{
  min_healthy_percentage: 1,
  instance_warmup: 1,
  checkpoint_percentages: [1],
  checkpoint_delay: 1,
  skip_matching: false,
}

Describes the preferences for an instance refresh.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #checkpoint_delay ⇒ Integer

  The amount of time, in seconds, to wait after a checkpoint before continuing.

• #checkpoint_percentages ⇒ Array<Integer>

  Threshold values for each checkpoint in ascending order.

• #instance_warmup ⇒ Integer

  The number of seconds until a newly launched instance is configured and ready to use.

• #min_healthy_percentage ⇒ Integer

  The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue.

• #skip_matching ⇒ Boolean

  A boolean value that indicates whether skip matching is enabled.

Instance Attribute Details

#checkpoint_delay ⇒ Integer

The amount of time, in seconds, to wait after a checkpoint before continuing. This property is optional, but if you specify a value for it, you must also specify a value for CheckpointPercentages. If you specify a value for CheckpointPercentages and not for CheckpointDelay, the CheckpointDelay defaults to 3600 (1 hour).

Returns:

• (Integer)

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

class RefreshPreferences < Struct.new(
  :min_healthy_percentage,
  :instance_warmup,
  :checkpoint_percentages,
  :checkpoint_delay,
  :skip_matching)
  SENSITIVE = []
  include Aws::Structure
end

#checkpoint_percentages ⇒ Array<Integer>

Threshold values for each checkpoint in ascending order. Each number must be unique. To replace all instances in the Auto Scaling group, the last number in the array must be 100.

For usage examples, see Adding checkpoints to an instance refresh in the Amazon EC2 Auto Scaling User Guide.

Returns:

• (Array<Integer>)

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

class RefreshPreferences < Struct.new(
  :min_healthy_percentage,
  :instance_warmup,
  :checkpoint_percentages,
  :checkpoint_delay,
  :skip_matching)
  SENSITIVE = []
  include Aws::Structure
end

#instance_warmup ⇒ Integer

The number of seconds until a newly launched instance is configured and ready to use. During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The default is to use the value for the health check grace period defined for the group.

Returns:

• (Integer)

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

class RefreshPreferences < Struct.new(
  :min_healthy_percentage,
  :instance_warmup,
  :checkpoint_percentages,
  :checkpoint_delay,
  :skip_matching)
  SENSITIVE = []
  include Aws::Structure
end

#min_healthy_percentage ⇒ Integer

The amount of capacity in the Auto Scaling group that must remain healthy during an instance refresh to allow the operation to continue. The value is expressed as a percentage of the desired capacity of the Auto Scaling group (rounded up to the nearest integer). The default is 90.

Setting the minimum healthy percentage to 100 percent limits the rate of replacement to one instance at a time. In contrast, setting it to 0 percent has the effect of replacing all instances at the same time.

Returns:

• (Integer)

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

class RefreshPreferences < Struct.new(
  :min_healthy_percentage,
  :instance_warmup,
  :checkpoint_percentages,
  :checkpoint_delay,
  :skip_matching)
  SENSITIVE = []
  include Aws::Structure
end

#skip_matching ⇒ Boolean

A boolean value that indicates whether skip matching is enabled. If true, then Amazon EC2 Auto Scaling skips replacing instances that match the desired configuration. If no desired configuration is specified, then it skips replacing instances that have the same configuration that is already set on the group. The default is false.

Returns:

• (Boolean)

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

class RefreshPreferences < Struct.new(
  :min_healthy_percentage,
  :instance_warmup,
  :checkpoint_percentages,
  :checkpoint_delay,
  :skip_matching)
  SENSITIVE = []
  include Aws::Structure
end