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.SetDesiredCapacity

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Sets the size of the specified Auto Scaling group.

If a scale-in activity occurs as a result of a new DesiredCapacity value that is lower than the current size of the group, the Auto Scaling group uses its termination policy to determine which instances to terminate.

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

Creating a Request

data SetDesiredCapacity Source #

See: newSetDesiredCapacity smart constructor.

Constructors

SetDesiredCapacity'

Fields

honorCooldown :: Maybe Bool
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.
autoScalingGroupName :: Text
The name of the Auto Scaling group.
desiredCapacity :: Int
The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain.

Instances

Instances details

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

newSetDesiredCapacity Source #

Arguments

:: Text	`SetDesiredCapacity`
-> Int	`SetDesiredCapacity`
-> SetDesiredCapacity

Create a value of SetDesiredCapacity 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:

$sel:honorCooldown:SetDesiredCapacity', setDesiredCapacity_honorCooldown - Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

SetDesiredCapacity, setDesiredCapacity_autoScalingGroupName - The name of the Auto Scaling group.

SetDesiredCapacity, setDesiredCapacity_desiredCapacity - The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain.

Request Lenses

setDesiredCapacity_honorCooldown :: Lens' SetDesiredCapacity (Maybe Bool) Source #

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does not honor the cooldown period during manual scaling activities.

setDesiredCapacity_autoScalingGroupName :: Lens' SetDesiredCapacity Text Source #

The name of the Auto Scaling group.

setDesiredCapacity_desiredCapacity :: Lens' SetDesiredCapacity Int Source #

The desired capacity is the initial capacity of the Auto Scaling group after this operation completes and the capacity it attempts to maintain.

Destructuring the Response

data SetDesiredCapacityResponse Source #

See: newSetDesiredCapacityResponse smart constructor.

Constructors

SetDesiredCapacityResponse'

Instances

Instances details

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

newSetDesiredCapacityResponse :: SetDesiredCapacityResponse Source #

Create a value of SetDesiredCapacityResponse with all optional fields omitted.

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