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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass ExecutePolicyType data as a 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 of the Auto Scaling group.

Returns:

  • (String)


2372
2373
2374
2375
2376
2377
2378
2379
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2372

class ExecutePolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :honor_cooldown,
  :metric_value,
  :breach_threshold)
  include Aws::Structure
end

#breach_thresholdFloat

The breach threshold for the alarm.

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

Returns:

  • (Float)


2372
2373
2374
2375
2376
2377
2378
2379
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2372

class ExecutePolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :honor_cooldown,
  :metric_value,
  :breach_threshold)
  include Aws::Structure
end

#honor_cooldownBoolean

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

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

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

Returns:

  • (Boolean)


2372
2373
2374
2375
2376
2377
2378
2379
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2372

class ExecutePolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :honor_cooldown,
  :metric_value,
  :breach_threshold)
  include Aws::Structure
end

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


2372
2373
2374
2375
2376
2377
2378
2379
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2372

class ExecutePolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :honor_cooldown,
  :metric_value,
  :breach_threshold)
  include Aws::Structure
end

#policy_nameString

The name or ARN of the policy.

Returns:

  • (String)


2372
2373
2374
2375
2376
2377
2378
2379
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2372

class ExecutePolicyType < Struct.new(
  :auto_scaling_group_name,
  :policy_name,
  :honor_cooldown,
  :metric_value,
  :breach_threshold)
  include Aws::Structure
end