class Aws::AutoScaling::ScalingPolicy

Public Class Methods

new(*args) click to toggle source

@overload def initialize(name, options = {})

@param [String] name
@option options [Client] :client

@overload def initialize(options = {})

@option options [required, String] :name
@option options [Client] :client
# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 22
def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @name = extract_name(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
  @waiter_block_warned = false
end

Public Instance Methods

adjustment_type() click to toggle source

Specifies how the scaling adjustment is interpreted (for example, an absolute number or a percentage). The valid values are `ChangeInCapacity`, `ExactCapacity`, and `PercentChangeInCapacity`. @return [String]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 77
def adjustment_type
  data[:adjustment_type]
end
alarms() click to toggle source

The CloudWatch alarms related to the policy. @return [Array<Types::Alarm>]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 132
def alarms
  data[:alarms]
end
auto_scaling_group_name() click to toggle source

The name of the Auto Scaling group. @return [String]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 40
def auto_scaling_group_name
  data[:auto_scaling_group_name]
end
client() click to toggle source

@return [Client]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 158
def client
  @client
end
cooldown() click to toggle source

The duration of the policy's cooldown period, in seconds. @return [Integer]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 105
def cooldown
  data[:cooldown]
end
data() click to toggle source

@return [Types::ScalingPolicy]

Returns the data for this {ScalingPolicy}. Calls
{Client#describe_policies} if {#data_loaded?} is `false`.
# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 178
def data
  load unless @data
  @data
end
data_loaded?() click to toggle source

@return [Boolean]

Returns `true` if this resource is loaded.  Accessing attributes or
{#data} on an unloaded resource will trigger a call to {#load}.
# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 186
def data_loaded?
  !!@data
end
delete(options = {}) click to toggle source

@example Request syntax with placeholder values

scaling_policy.delete({
  auto_scaling_group_name: "XmlStringMaxLen255",
})

@param [Hash] options ({}) @option options [String] :auto_scaling_group_name

The name of the Auto Scaling group.

@return [EmptyStructure]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 298
def delete(options = {})
  options = options.merge(policy_name: @name)
  resp = @client.delete_policy(options)
  resp.data
end
enabled() click to toggle source

Indicates whether the policy is enabled (`true`) or disabled (`false`). @return [Boolean]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 145
def enabled
  data[:enabled]
end
estimated_instance_warmup() click to toggle source

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. @return [Integer]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 126
def estimated_instance_warmup
  data[:estimated_instance_warmup]
end
execute(options = {}) click to toggle source

@example Request syntax with placeholder values

scaling_policy.execute({
  auto_scaling_group_name: "XmlStringMaxLen255",
  honor_cooldown: false,
  metric_value: 1.0,
  breach_threshold: 1.0,
})

@param [Hash] options ({}) @option options [String] :auto_scaling_group_name

The name of the Auto Scaling group.

@option options [Boolean] :honor_cooldown

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown
period to complete before executing the policy.

Valid only if the policy type is `SimpleScaling`. For more
information, see [Scaling cooldowns for Amazon EC2 Auto Scaling][1] in
the *Amazon EC2 Auto Scaling User Guide*.

[1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html

@option options [Float] :metric_value

The metric value to compare to `BreachThreshold`. This enables you to
execute a policy of type `StepScaling` and determine which step
adjustment to use. For example, if the breach threshold is 50 and you
want to use a step adjustment with a lower bound of 0 and an upper
bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step
adjustment for the policy, the call returns an error.

Required if the policy type is `StepScaling` and not supported
otherwise.

@option options [Float] :breach_threshold

The breach threshold for the alarm.

Required if the policy type is `StepScaling` and not supported
otherwise.

@return [EmptyStructure]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 344
def execute(options = {})
  options = options.merge(policy_name: @name)
  resp = @client.execute_policy(options)
  resp.data
end
group() click to toggle source

@return [AutoScalingGroup, nil]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 353
def group
  if data[:auto_scaling_group_name]
    AutoScalingGroup.new(
      name: data[:auto_scaling_group_name],
      client: @client
    )
  else
    nil
  end
end
identifiers() click to toggle source

@deprecated @api private

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 366
def identifiers
  { name: @name }
end
load() click to toggle source

Loads, or reloads {#data} for the current {ScalingPolicy}. Returns `self` making it possible to chain methods.

scaling_policy.reload.data

@return [self]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 168
def load
  resp = @client.describe_policies(policy_names: [@name])
  @data = resp.scaling_policies[0]
  self
end
Also aliased as: reload
metric_aggregation_type() click to toggle source

The aggregation type for the CloudWatch metrics. The valid values are `Minimum`, `Maximum`, and `Average`. @return [String]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 119
def metric_aggregation_type
  data[:metric_aggregation_type]
end
min_adjustment_magnitude() click to toggle source

The minimum value to scale by when the adjustment type is `PercentChangeInCapacity`. @return [Integer]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 91
def min_adjustment_magnitude
  data[:min_adjustment_magnitude]
end
min_adjustment_step() click to toggle source

Available for backward compatibility. Use `MinAdjustmentMagnitude` instead. @return [Integer]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 84
def min_adjustment_step
  data[:min_adjustment_step]
end
name() click to toggle source

@return [String]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 33
def name
  @name
end
Also aliased as: policy_name
policy_arn() click to toggle source

The Amazon Resource Name (ARN) of the policy. @return [String]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 46
def policy_arn
  data[:policy_arn]
end
policy_name()
Alias for: name
policy_type() click to toggle source

One of the following policy types:

  • `TargetTrackingScaling`

  • `StepScaling`

  • `SimpleScaling` (default)

  • `PredictiveScaling`

For more information, see [Target tracking scaling policies] and

Step and simple scaling policies][2

in the *Amazon EC2 Auto Scaling

User Guide*.

[1]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-target-tracking.html [2]: docs.aws.amazon.com/autoscaling/ec2/userguide/as-scaling-simple-step.html @return [String]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 69
def policy_type
  data[:policy_type]
end
predictive_scaling_configuration() click to toggle source

A predictive scaling policy. @return [Types::PredictiveScalingConfiguration]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 151
def predictive_scaling_configuration
  data[:predictive_scaling_configuration]
end
reload()
Alias for: load
scaling_adjustment() click to toggle source

The amount by which to scale, based on the specified adjustment type. A positive value adds to the current capacity while a negative number removes from the current capacity. @return [Integer]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 99
def scaling_adjustment
  data[:scaling_adjustment]
end
step_adjustments() click to toggle source

A set of adjustments that enable you to scale based on the size of the alarm breach. @return [Array<Types::StepAdjustment>]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 112
def step_adjustments
  data[:step_adjustments]
end
target_tracking_configuration() click to toggle source

A target tracking scaling policy. @return [Types::TargetTrackingConfiguration]

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 138
def target_tracking_configuration
  data[:target_tracking_configuration]
end
wait_until(options = {}, &block) click to toggle source

@deprecated Use [Aws::AutoScaling::Client] wait_until instead

Waiter polls an API operation until a resource enters a desired state.

@note The waiting operation is performed on a copy. The original resource

remains unchanged.

## Basic Usage

Waiter will polls until it is successful, it fails by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop until condition is true
resource.wait_until(options) {|resource| condition}

## Example

instance.wait_until(max_attempts:10, delay:5) do |instance|
  instance.state.name == 'running'
end

## Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. The waiting condition is set by passing a block to {#wait_until}:

# poll for ~25 seconds
resource.wait_until(max_attempts:5,delay:5) {|resource|...}

## Callbacks

You can be notified before each polling attempt and before each delay. If you throw `:success` or `:failure` from these callbacks, it will terminate the waiter.

started_at = Time.now
# poll for 1 hour, instead of a number of attempts
proc = Proc.new do |attempts, response|
  throw :failure if Time.now - started_at > 3600
end

  # disable max attempts
instance.wait_until(before_wait:proc, max_attempts:nil) {...}

## Handling Errors

When a waiter is successful, it returns the Resource. When a waiter fails, it raises an error.

begin
  resource.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

@yieldparam [Resource] resource to be used in the waiting condition.

@raise [Aws::Waiters::Errors::FailureStateError] Raised when the waiter

terminates because the waiter has entered a state that it will not
transition out of, preventing success.

yet successful.

@raise [Aws::Waiters::Errors::UnexpectedError] Raised when an error is

encountered while polling for a resource that is not expected.

@raise [NotImplementedError] Raised when the resource does not

@option options [Integer] :max_attempts (10) Maximum number of attempts @option options [Integer] :delay (10) Delay between each attempt in seconds @option options [Proc] :before_attempt (nil) Callback invoked before each attempt @option options [Proc] :before_wait (nil) Callback invoked before each wait @return [Resource] if the waiter was successful

# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 270
def wait_until(options = {}, &block)
  self_copy = self.dup
  attempts = 0
  options[:max_attempts] = 10 unless options.key?(:max_attempts)
  options[:delay] ||= 10
  options[:poller] = Proc.new do
    attempts += 1
    if block.call(self_copy)
      [:success, self_copy]
    else
      self_copy.reload unless attempts == options[:max_attempts]
      :retry
    end
  end
  Aws::Waiters::Waiter.new(options).wait({})
end

Private Instance Methods

extract_name(args, options) click to toggle source
# File lib/aws-sdk-autoscaling/scaling_policy.rb, line 373
def extract_name(args, options)
  value = args[0] || options.delete(:name)
  case value
  when String then value
  when nil then raise ArgumentError, "missing required option :name"
  else
    msg = "expected :name to be a String, got #{value.class}"
    raise ArgumentError, msg
  end
end