amazonka-autoscaling-1.6.0: Amazon Auto Scaling SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.AutoScaling.ExecutePolicy

Contents

Description

Executes the specified policy.

Synopsis

Creating a Request

executePolicy Source #

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 is StepScaling . For more information, see Auto Scaling Cooldowns in the Auto Scaling User Guide .
  • epMetricValue - 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 - The name of the Auto Scaling group.
  • epBreachThreshold - The breach threshold for the alarm. This parameter is required if the policy type is StepScaling and not supported otherwise.
  • epPolicyName - The name or ARN of the policy.

data ExecutePolicy Source #

See: executePolicy smart constructor.

Instances

Eq ExecutePolicy Source # 
Data ExecutePolicy Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutePolicy -> c ExecutePolicy #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutePolicy #

toConstr :: ExecutePolicy -> Constr #

dataTypeOf :: ExecutePolicy -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExecutePolicy) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutePolicy) #

gmapT :: (forall b. Data b => b -> b) -> ExecutePolicy -> ExecutePolicy #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicy -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicy -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExecutePolicy -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutePolicy -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutePolicy -> m ExecutePolicy #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicy -> m ExecutePolicy #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicy -> m ExecutePolicy #

Read ExecutePolicy Source # 
Show ExecutePolicy Source # 
Generic ExecutePolicy Source # 

Associated Types

type Rep ExecutePolicy :: * -> * #

Hashable ExecutePolicy Source # 
NFData ExecutePolicy Source # 

Methods

rnf :: ExecutePolicy -> () #

AWSRequest ExecutePolicy Source # 
ToHeaders ExecutePolicy Source # 
ToPath ExecutePolicy Source # 
ToQuery ExecutePolicy Source # 
type Rep ExecutePolicy Source # 
type Rep ExecutePolicy = D1 * (MetaData "ExecutePolicy" "Network.AWS.AutoScaling.ExecutePolicy" "amazonka-autoscaling-1.6.0-Cbg5YTxJJyv60SSUTcTsy3" False) (C1 * (MetaCons "ExecutePolicy'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_epHonorCooldown") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) (S1 * (MetaSel (Just Symbol "_epMetricValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double)))) ((:*:) * (S1 * (MetaSel (Just Symbol "_epAutoScalingGroupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_epBreachThreshold") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Double))) (S1 * (MetaSel (Just Symbol "_epPolicyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))))
type Rs ExecutePolicy Source # 

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.

Instances

Eq ExecutePolicyResponse Source # 
Data ExecutePolicyResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ExecutePolicyResponse -> c ExecutePolicyResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ExecutePolicyResponse #

toConstr :: ExecutePolicyResponse -> Constr #

dataTypeOf :: ExecutePolicyResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ExecutePolicyResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ExecutePolicyResponse) #

gmapT :: (forall b. Data b => b -> b) -> ExecutePolicyResponse -> ExecutePolicyResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicyResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ExecutePolicyResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> ExecutePolicyResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ExecutePolicyResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ExecutePolicyResponse -> m ExecutePolicyResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicyResponse -> m ExecutePolicyResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ExecutePolicyResponse -> m ExecutePolicyResponse #

Read ExecutePolicyResponse Source # 
Show ExecutePolicyResponse Source # 
Generic ExecutePolicyResponse Source # 
NFData ExecutePolicyResponse Source # 

Methods

rnf :: ExecutePolicyResponse -> () #

type Rep ExecutePolicyResponse Source # 
type Rep ExecutePolicyResponse = D1 * (MetaData "ExecutePolicyResponse" "Network.AWS.AutoScaling.ExecutePolicy" "amazonka-autoscaling-1.6.0-Cbg5YTxJJyv60SSUTcTsy3" False) (C1 * (MetaCons "ExecutePolicyResponse'" PrefixI False) (U1 *))