Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Executes the specified policy.
- executePolicy :: Text -> ExecutePolicy
- data ExecutePolicy
- epHonorCooldown :: Lens' ExecutePolicy (Maybe Bool)
- epMetricValue :: Lens' ExecutePolicy (Maybe Double)
- epAutoScalingGroupName :: Lens' ExecutePolicy (Maybe Text)
- epBreachThreshold :: Lens' ExecutePolicy (Maybe Double)
- epPolicyName :: Lens' ExecutePolicy Text
- executePolicyResponse :: ExecutePolicyResponse
- data ExecutePolicyResponse
Creating a Request
Creates a value of ExecutePolicy
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epHonorCooldown
- Indicates whether Auto Scaling waits for the cooldown period to complete before executing the policy. This parameter is not supported if the policy type isStepScaling
. For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide .epMetricValue
- The metric value to compare toBreachThreshold
. This enables you to execute a policy of typeStepScaling
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 isStepScaling
and not supported otherwise.epAutoScalingGroupName
- The name of the Auto Scaling group.epBreachThreshold
- The breach threshold for the alarm. This parameter is required if the policy type isStepScaling
and not supported otherwise.epPolicyName
- The name or ARN of the policy.
data ExecutePolicy Source #
See: executePolicy
smart constructor.
Request Lenses
epHonorCooldown :: Lens' ExecutePolicy (Maybe Bool) Source #
Indicates whether 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 Auto Scaling Cooldowns in the Auto Scaling User Guide .
epMetricValue :: Lens' ExecutePolicy (Maybe Double) Source #
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.
epAutoScalingGroupName :: Lens' ExecutePolicy (Maybe Text) Source #
The name of the Auto Scaling group.
epBreachThreshold :: Lens' ExecutePolicy (Maybe Double) Source #
The breach threshold for the alarm. This parameter is required if the policy type is StepScaling
and not supported otherwise.
epPolicyName :: Lens' ExecutePolicy Text Source #
The name or ARN of the policy.
Destructuring the Response
executePolicyResponse :: ExecutePolicyResponse Source #
Creates a value of ExecutePolicyResponse
with the minimum fields required to make a request.
data ExecutePolicyResponse Source #
See: executePolicyResponse
smart constructor.