libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling
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.AutoScaling.SetDesiredCapacity

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.

Synopsis

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
Eq SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Read SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Show SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Generic SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Associated Types

type Rep SetDesiredCapacity :: Type -> Type #

NFData SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Methods

rnf :: SetDesiredCapacity -> () #

Hashable SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

AWSRequest SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Associated Types

type AWSResponse SetDesiredCapacity #

ToHeaders SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

ToPath SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

ToQuery SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

type Rep SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

type Rep SetDesiredCapacity = D1 ('MetaData "SetDesiredCapacity" "Amazonka.AutoScaling.SetDesiredCapacity" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" '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))))
type AWSResponse SetDesiredCapacity Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

newSetDesiredCapacity Source #

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.

$sel:autoScalingGroupName:SetDesiredCapacity', setDesiredCapacity_autoScalingGroupName - The name of the Auto Scaling group.

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

Instances

Instances details
Eq SetDesiredCapacityResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Read SetDesiredCapacityResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Show SetDesiredCapacityResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Generic SetDesiredCapacityResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

Associated Types

type Rep SetDesiredCapacityResponse :: Type -> Type #

NFData SetDesiredCapacityResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

type Rep SetDesiredCapacityResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.SetDesiredCapacity

type Rep SetDesiredCapacityResponse = D1 ('MetaData "SetDesiredCapacityResponse" "Amazonka.AutoScaling.SetDesiredCapacity" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" '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.