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.OpsWorks.SetLoadBasedAutoScaling

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Creating a Request

data SetLoadBasedAutoScaling Source #

See: newSetLoadBasedAutoScaling smart constructor.

Constructors

SetLoadBasedAutoScaling'

Fields

downScaling :: Maybe AutoScalingThresholds
An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.
enable :: Maybe Bool
Enables load-based auto scaling for the layer.
upScaling :: Maybe AutoScalingThresholds
An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.
layerId :: Text
The layer ID.

Instances

Instances details

ToJSON SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods toJSON :: SetLoadBasedAutoScaling -> Value # toEncoding :: SetLoadBasedAutoScaling -> Encoding # toJSONList :: [SetLoadBasedAutoScaling] -> Value # toEncodingList :: [SetLoadBasedAutoScaling] -> Encoding #
ToHeaders SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods toHeaders :: SetLoadBasedAutoScaling -> [Header] #
ToPath SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods toPath :: SetLoadBasedAutoScaling -> ByteString #
ToQuery SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods toQuery :: SetLoadBasedAutoScaling -> QueryString #
AWSRequest SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Associated Types type AWSResponse SetLoadBasedAutoScaling # Methods request :: (Service -> Service) -> SetLoadBasedAutoScaling -> Request SetLoadBasedAutoScaling # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetLoadBasedAutoScaling -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetLoadBasedAutoScaling))) #
Generic SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Associated Types type Rep SetLoadBasedAutoScaling :: Type -> Type # Methods from :: SetLoadBasedAutoScaling -> Rep SetLoadBasedAutoScaling x # to :: Rep SetLoadBasedAutoScaling x -> SetLoadBasedAutoScaling #
Read SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods readsPrec :: Int -> ReadS SetLoadBasedAutoScaling # readList :: ReadS [SetLoadBasedAutoScaling] # readPrec :: ReadPrec SetLoadBasedAutoScaling # readListPrec :: ReadPrec [SetLoadBasedAutoScaling] #
Show SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods showsPrec :: Int -> SetLoadBasedAutoScaling -> ShowS # show :: SetLoadBasedAutoScaling -> String # showList :: [SetLoadBasedAutoScaling] -> ShowS #
NFData SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods rnf :: SetLoadBasedAutoScaling -> () #
Eq SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods (==) :: SetLoadBasedAutoScaling -> SetLoadBasedAutoScaling -> Bool # (/=) :: SetLoadBasedAutoScaling -> SetLoadBasedAutoScaling -> Bool #
Hashable SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods hashWithSalt :: Int -> SetLoadBasedAutoScaling -> Int # hash :: SetLoadBasedAutoScaling -> Int #
type AWSResponse SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling type AWSResponse SetLoadBasedAutoScaling = SetLoadBasedAutoScalingResponse
type Rep SetLoadBasedAutoScaling Source #
Instance details Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling type Rep SetLoadBasedAutoScaling = D1 ('MetaData "SetLoadBasedAutoScaling" "Amazonka.OpsWorks.SetLoadBasedAutoScaling" "amazonka-opsworks-2.0-7XrzSD2vbuN9lVUGWMVZ7S" 'False) (C1 ('MetaCons "SetLoadBasedAutoScaling'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "downScaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoScalingThresholds)) :: S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "upScaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoScalingThresholds)) :*: S1 ('MetaSel ('Just "layerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newSetLoadBasedAutoScaling Source #

Arguments

:: Text	`SetLoadBasedAutoScaling`
-> SetLoadBasedAutoScaling

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

SetLoadBasedAutoScaling, setLoadBasedAutoScaling_downScaling - An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.

SetLoadBasedAutoScaling, setLoadBasedAutoScaling_enable - Enables load-based auto scaling for the layer.

SetLoadBasedAutoScaling, setLoadBasedAutoScaling_upScaling - An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.

SetLoadBasedAutoScaling, setLoadBasedAutoScaling_layerId - The layer ID.

Request Lenses

setLoadBasedAutoScaling_downScaling :: Lens' SetLoadBasedAutoScaling (Maybe AutoScalingThresholds) Source #

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.

setLoadBasedAutoScaling_enable :: Lens' SetLoadBasedAutoScaling (Maybe Bool) Source #

Enables load-based auto scaling for the layer.

setLoadBasedAutoScaling_upScaling :: Lens' SetLoadBasedAutoScaling (Maybe AutoScalingThresholds) Source #

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.

setLoadBasedAutoScaling_layerId :: Lens' SetLoadBasedAutoScaling Text Source #

The layer ID.

Destructuring the Response

data SetLoadBasedAutoScalingResponse Source #

See: newSetLoadBasedAutoScalingResponse smart constructor.

Constructors

SetLoadBasedAutoScalingResponse'

Instances

Instances details

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

newSetLoadBasedAutoScalingResponse :: SetLoadBasedAutoScalingResponse Source #

Create a value of SetLoadBasedAutoScalingResponse with all optional fields omitted.

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