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

Amazonka.OpsWorks.SetLoadBasedAutoScaling

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.

Synopsis

Creating a Request

data SetLoadBasedAutoScaling Source #

See: newSetLoadBasedAutoScaling smart constructor.

Constructors

SetLoadBasedAutoScaling' 

Fields

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

  • enable :: Maybe Bool

    Enables load-based auto scaling for the layer.

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

  • layerId :: Text

    The layer ID.

Instances

Instances details
Eq SetLoadBasedAutoScaling Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

Methods

(==) :: SetLoadBasedAutoScaling -> SetLoadBasedAutoScaling -> Bool #

(/=) :: SetLoadBasedAutoScaling -> SetLoadBasedAutoScaling -> Bool #

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 #

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 #

NFData SetLoadBasedAutoScaling Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

Methods

rnf :: SetLoadBasedAutoScaling -> () #

Hashable SetLoadBasedAutoScaling Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

Methods

hashWithSalt :: Int -> SetLoadBasedAutoScaling -> Int #

hash :: SetLoadBasedAutoScaling -> Int #

ToJSON SetLoadBasedAutoScaling Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

Methods

toJSON :: SetLoadBasedAutoScaling -> Value #

toEncoding :: SetLoadBasedAutoScaling -> Encoding #

toJSONList :: [SetLoadBasedAutoScaling] -> Value #

toEncodingList :: [SetLoadBasedAutoScaling] -> Encoding #

AWSRequest SetLoadBasedAutoScaling Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

Associated Types

type AWSResponse SetLoadBasedAutoScaling #

Methods

request :: SetLoadBasedAutoScaling -> Request SetLoadBasedAutoScaling #

response :: MonadResource m => Logger -> Service -> Proxy SetLoadBasedAutoScaling -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetLoadBasedAutoScaling))) #

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 #

type Rep SetLoadBasedAutoScaling Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

type Rep SetLoadBasedAutoScaling = D1 ('MetaData "SetLoadBasedAutoScaling" "Amazonka.OpsWorks.SetLoadBasedAutoScaling" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" 'False) (C1 ('MetaCons "SetLoadBasedAutoScaling'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "upScaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoScalingThresholds)) :*: S1 ('MetaSel ('Just "enable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "downScaling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AutoScalingThresholds)) :*: S1 ('MetaSel ('Just "layerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse SetLoadBasedAutoScaling Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

type AWSResponse SetLoadBasedAutoScaling = SetLoadBasedAutoScalingResponse

newSetLoadBasedAutoScaling Source #

Arguments

:: Text

$sel:layerId: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:

$sel:upScaling: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.

$sel:enable:SetLoadBasedAutoScaling', setLoadBasedAutoScaling_enable - Enables load-based auto scaling for the layer.

$sel:downScaling: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.

$sel:layerId:SetLoadBasedAutoScaling', setLoadBasedAutoScaling_layerId - The layer ID.

Request Lenses

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_enable :: Lens' SetLoadBasedAutoScaling (Maybe Bool) Source #

Enables load-based auto scaling for the layer.

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_layerId :: Lens' SetLoadBasedAutoScaling Text Source #

The layer ID.

Destructuring the Response

data SetLoadBasedAutoScalingResponse Source #

See: newSetLoadBasedAutoScalingResponse smart constructor.

Constructors

SetLoadBasedAutoScalingResponse' 

Instances

Instances details
Eq SetLoadBasedAutoScalingResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

Methods

(==) :: SetLoadBasedAutoScalingResponse -> SetLoadBasedAutoScalingResponse -> Bool #

(/=) :: SetLoadBasedAutoScalingResponse -> SetLoadBasedAutoScalingResponse -> Bool #

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 #

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 #

NFData SetLoadBasedAutoScalingResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

Methods

rnf :: SetLoadBasedAutoScalingResponse -> () #

type Rep SetLoadBasedAutoScalingResponse Source # 
Instance details

Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling

type Rep SetLoadBasedAutoScalingResponse = D1 ('MetaData "SetLoadBasedAutoScalingResponse" "Amazonka.OpsWorks.SetLoadBasedAutoScaling" "libZSservicesZSamazonka-opsworksZSamazonka-opsworks" '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.