amazonka-autoscaling-2.0: Amazon Auto Scaling SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.AutoScaling.EnterStandby

Description

Moves the specified instances into the standby state.

If you choose to decrement the desired capacity of the Auto Scaling group, the instances can enter standby as long as the desired capacity of the Auto Scaling group after the instances are placed into standby is equal to or greater than the minimum capacity of the group.

If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group launches new instances to replace the instances on standby.

For more information, see Temporarily removing instances from your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.

Synopsis

Creating a Request

data EnterStandby Source #

See: newEnterStandby smart constructor.

Constructors

EnterStandby' 

Fields

Instances

Instances details
ToHeaders EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

ToPath EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

ToQuery EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

AWSRequest EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Associated Types

type AWSResponse EnterStandby #

Generic EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Associated Types

type Rep EnterStandby :: Type -> Type #

Read EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Show EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

NFData EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Methods

rnf :: EnterStandby -> () #

Eq EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Hashable EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

type AWSResponse EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

type Rep EnterStandby Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

type Rep EnterStandby = D1 ('MetaData "EnterStandby" "Amazonka.AutoScaling.EnterStandby" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "EnterStandby'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "autoScalingGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shouldDecrementDesiredCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool))))

newEnterStandby Source #

Create a value of EnterStandby 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:instanceIds:EnterStandby', enterStandby_instanceIds - The IDs of the instances. You can specify up to 20 instances.

EnterStandby, enterStandby_autoScalingGroupName - The name of the Auto Scaling group.

$sel:shouldDecrementDesiredCapacity:EnterStandby', enterStandby_shouldDecrementDesiredCapacity - Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

Request Lenses

enterStandby_instanceIds :: Lens' EnterStandby (Maybe [Text]) Source #

The IDs of the instances. You can specify up to 20 instances.

enterStandby_autoScalingGroupName :: Lens' EnterStandby Text Source #

The name of the Auto Scaling group.

enterStandby_shouldDecrementDesiredCapacity :: Lens' EnterStandby Bool Source #

Indicates whether to decrement the desired capacity of the Auto Scaling group by the number of instances moved to Standby mode.

Destructuring the Response

data EnterStandbyResponse Source #

See: newEnterStandbyResponse smart constructor.

Constructors

EnterStandbyResponse' 

Fields

Instances

Instances details
Generic EnterStandbyResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Associated Types

type Rep EnterStandbyResponse :: Type -> Type #

Read EnterStandbyResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Show EnterStandbyResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

NFData EnterStandbyResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

Methods

rnf :: EnterStandbyResponse -> () #

Eq EnterStandbyResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

type Rep EnterStandbyResponse Source # 
Instance details

Defined in Amazonka.AutoScaling.EnterStandby

type Rep EnterStandbyResponse = D1 ('MetaData "EnterStandbyResponse" "Amazonka.AutoScaling.EnterStandby" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "EnterStandbyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "activities") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Activity])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newEnterStandbyResponse Source #

Create a value of EnterStandbyResponse 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:activities:EnterStandbyResponse', enterStandbyResponse_activities - The activities related to moving instances into Standby mode.

$sel:httpStatus:EnterStandbyResponse', enterStandbyResponse_httpStatus - The response's http status code.

Response Lenses

enterStandbyResponse_activities :: Lens' EnterStandbyResponse (Maybe [Activity]) Source #

The activities related to moving instances into Standby mode.