You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AutoScaling::Types::ExecutePolicyType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ExecutePolicyType as input to an Aws::Client method, you can use a vanilla Hash:

{
  auto_scaling_group_name: "ResourceName",
  policy_name: "ResourceName", # required
  honor_cooldown: false,
  metric_value: 1.0,
  breach_threshold: 1.0,
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name or Amazon Resource Name (ARN) of the Auto Scaling group.

Returns:

  • (String)

    The name or Amazon Resource Name (ARN) of the Auto Scaling group.

#breach_thresholdFloat

The breach threshold for the alarm.

This parameter is required if the policy type is StepScaling and not supported otherwise.

Returns:

  • (Float)

    The breach threshold for the alarm.

#honor_cooldownBoolean

If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy. Otherwise, Auto Scaling executes the policy without waiting for the cooldown period to complete.

This parameter is not supported if the policy type is StepScaling.

For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide.

Returns:

  • (Boolean)

    If this parameter is true, Auto Scaling waits for the cooldown period to complete before executing the policy.

#metric_valueFloat

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.

This parameter is required if the policy type is StepScaling and not supported otherwise.

Returns:

  • (Float)

    The metric value to compare to BreachThreshold.

#policy_nameString

The name or ARN of the policy.

Returns:

  • (String)

    The name or ARN of the policy.