Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AutoScaling.ExecutePolicy

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Executes the specified policy. This can be useful for testing the design of your scaling policy.

Creating a Request

data ExecutePolicy Source #

See: newExecutePolicy smart constructor.

Constructors

ExecutePolicy'

Fields

autoScalingGroupName :: Maybe Text
The name of the Auto Scaling group.
breachThreshold :: Maybe Double
The breach threshold for the alarm.
Required if the policy type is StepScaling and not supported otherwise.
honorCooldown :: Maybe Bool
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.
Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
metricValue :: Maybe Double
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.
Required if the policy type is StepScaling and not supported otherwise.
policyName :: Text
The name or ARN of the policy.

Instances

Instances details

ToHeaders ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods toHeaders :: ExecutePolicy -> [Header] #
ToPath ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods toPath :: ExecutePolicy -> ByteString #
ToQuery ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods toQuery :: ExecutePolicy -> QueryString #
AWSRequest ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Associated Types type AWSResponse ExecutePolicy # Methods request :: (Service -> Service) -> ExecutePolicy -> Request ExecutePolicy # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ExecutePolicy -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ExecutePolicy))) #
Generic ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Associated Types type Rep ExecutePolicy :: Type -> Type # Methods from :: ExecutePolicy -> Rep ExecutePolicy x # to :: Rep ExecutePolicy x -> ExecutePolicy #
Read ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods readsPrec :: Int -> ReadS ExecutePolicy # readList :: ReadS [ExecutePolicy] # readPrec :: ReadPrec ExecutePolicy # readListPrec :: ReadPrec [ExecutePolicy] #
Show ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods showsPrec :: Int -> ExecutePolicy -> ShowS # show :: ExecutePolicy -> String # showList :: [ExecutePolicy] -> ShowS #
NFData ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods rnf :: ExecutePolicy -> () #
Eq ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods (==) :: ExecutePolicy -> ExecutePolicy -> Bool # (/=) :: ExecutePolicy -> ExecutePolicy -> Bool #
Hashable ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods hashWithSalt :: Int -> ExecutePolicy -> Int # hash :: ExecutePolicy -> Int #
type AWSResponse ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy type AWSResponse ExecutePolicy = ExecutePolicyResponse
type Rep ExecutePolicy Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy type Rep ExecutePolicy = D1 ('MetaData "ExecutePolicy" "Amazonka.AutoScaling.ExecutePolicy" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "ExecutePolicy'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "breachThreshold") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "honorCooldown") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "metricValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: S1 ('MetaSel ('Just "policyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newExecutePolicy Source #

Arguments

:: Text	`ExecutePolicy`
-> ExecutePolicy

Create a value of ExecutePolicy with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ExecutePolicy, executePolicy_autoScalingGroupName - The name of the Auto Scaling group.

$sel:breachThreshold:ExecutePolicy', executePolicy_breachThreshold - The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

$sel:honorCooldown:ExecutePolicy', executePolicy_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 SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

$sel:metricValue:ExecutePolicy', executePolicy_metricValue - 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.

Required if the policy type is StepScaling and not supported otherwise.

ExecutePolicy, executePolicy_policyName - The name or ARN of the policy.

Request Lenses

executePolicy_autoScalingGroupName :: Lens' ExecutePolicy (Maybe Text) Source #

The name of the Auto Scaling group.

executePolicy_breachThreshold :: Lens' ExecutePolicy (Maybe Double) Source #

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

executePolicy_honorCooldown :: Lens' ExecutePolicy (Maybe Bool) Source #

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

Valid only if the policy type is SimpleScaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

executePolicy_metricValue :: 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.

Required if the policy type is StepScaling and not supported otherwise.

executePolicy_policyName :: Lens' ExecutePolicy Text Source #

The name or ARN of the policy.

Destructuring the Response

data ExecutePolicyResponse Source #

See: newExecutePolicyResponse smart constructor.

Constructors

ExecutePolicyResponse'

Instances

Instances details

Generic ExecutePolicyResponse Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Associated Types type Rep ExecutePolicyResponse :: Type -> Type # Methods from :: ExecutePolicyResponse -> Rep ExecutePolicyResponse x # to :: Rep ExecutePolicyResponse x -> ExecutePolicyResponse #
Read ExecutePolicyResponse Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods readsPrec :: Int -> ReadS ExecutePolicyResponse # readList :: ReadS [ExecutePolicyResponse] # readPrec :: ReadPrec ExecutePolicyResponse # readListPrec :: ReadPrec [ExecutePolicyResponse] #
Show ExecutePolicyResponse Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods showsPrec :: Int -> ExecutePolicyResponse -> ShowS # show :: ExecutePolicyResponse -> String # showList :: [ExecutePolicyResponse] -> ShowS #
NFData ExecutePolicyResponse Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods rnf :: ExecutePolicyResponse -> () #
Eq ExecutePolicyResponse Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy Methods (==) :: ExecutePolicyResponse -> ExecutePolicyResponse -> Bool # (/=) :: ExecutePolicyResponse -> ExecutePolicyResponse -> Bool #
type Rep ExecutePolicyResponse Source #
Instance details Defined in Amazonka.AutoScaling.ExecutePolicy type Rep ExecutePolicyResponse = D1 ('MetaData "ExecutePolicyResponse" "Amazonka.AutoScaling.ExecutePolicy" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "ExecutePolicyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newExecutePolicyResponse :: ExecutePolicyResponse Source #

Create a value of ExecutePolicyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.