Execute Policy
autoscaling_execute_policy | R Documentation |
Executes the specified policy¶
Description¶
Executes the specified policy. This can be useful for testing the design of your scaling policy.
Usage¶
autoscaling_execute_policy(AutoScalingGroupName, PolicyName,
HonorCooldown, MetricValue, BreachThreshold)
Arguments¶
AutoScalingGroupName |
The name of the Auto Scaling group. |
PolicyName |
[required] The name or ARN of the policy. |
HonorCooldown |
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy. Valid only if the policy type is |
MetricValue |
The metric value to compare to 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 |
BreachThreshold |
The breach threshold for the alarm. Required if the policy type is |
Value¶
An empty list.
Request syntax¶
svc$execute_policy(
AutoScalingGroupName = "string",
PolicyName = "string",
HonorCooldown = TRUE|FALSE,
MetricValue = 123.0,
BreachThreshold = 123.0
)
Examples¶
## Not run:
# This example executes the specified policy.
svc$execute_policy(
AutoScalingGroupName = "my-auto-scaling-group",
BreachThreshold = 50,
MetricValue = 59,
PolicyName = "my-step-scale-out-policy"
)
## End(Not run)