Amazonka.AutoScaling.EnterStandby

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.

Creating a Request

data EnterStandby

See: newEnterStandby smart constructor.

Constructors

EnterStandby'

Fields

• instanceIds :: Maybe [Text]

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

• autoScalingGroupName :: Text

  The name of the Auto Scaling group.

• shouldDecrementDesiredCapacity :: Bool

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

Instances

ToHeaders EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

toHeaders :: EnterStandby -> [Header]

ToPath EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

toPath :: EnterStandby -> ByteString

ToQuery EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

toQuery :: EnterStandby -> QueryString

AWSRequest EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Associated Types

type AWSResponse EnterStandby

Methods

request :: (Service -> Service) -> EnterStandby -> Request EnterStandby

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy EnterStandby -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse EnterStandby)))

Generic EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Associated Types

type Rep EnterStandby :: Type -> Type

Methods

from :: EnterStandby -> Rep EnterStandby x

to :: Rep EnterStandby x -> EnterStandby

Read EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

readsPrec :: Int -> ReadS EnterStandby

readList :: ReadS [EnterStandby]

readPrec :: ReadPrec EnterStandby

readListPrec :: ReadPrec [EnterStandby]

Show EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

showsPrec :: Int -> EnterStandby -> ShowS

show :: EnterStandby -> String

showList :: [EnterStandby] -> ShowS

NFData EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

rnf :: EnterStandby -> ()

Eq EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

(==) :: EnterStandby -> EnterStandby -> Bool

(/=) :: EnterStandby -> EnterStandby -> Bool

Hashable EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

Methods

hashWithSalt :: Int -> EnterStandby -> Int

hash :: EnterStandby -> Int

type AWSResponse EnterStandby

Defined in Amazonka.AutoScaling.EnterStandby

type AWSResponse EnterStandby = EnterStandbyResponse

type Rep EnterStandby

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

Arguments

:: Text

EnterStandby

-> Bool

$sel:shouldDecrementDesiredCapacity:EnterStandby'

-> EnterStandby

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])

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

enterStandby_autoScalingGroupName :: Lens' EnterStandby Text

The name of the Auto Scaling group.

enterStandby_shouldDecrementDesiredCapacity :: Lens' EnterStandby Bool

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

See: newEnterStandbyResponse smart constructor.

Constructors

EnterStandbyResponse'

Fields

• activities :: Maybe [Activity]

  The activities related to moving instances into Standby mode.

• httpStatus :: Int

  The response's http status code.

Instances

Generic EnterStandbyResponse

Defined in Amazonka.AutoScaling.EnterStandby

Associated Types

type Rep EnterStandbyResponse :: Type -> Type

Methods

from :: EnterStandbyResponse -> Rep EnterStandbyResponse x

to :: Rep EnterStandbyResponse x -> EnterStandbyResponse

Read EnterStandbyResponse

Defined in Amazonka.AutoScaling.EnterStandby

Methods

readsPrec :: Int -> ReadS EnterStandbyResponse

readList :: ReadS [EnterStandbyResponse]

readPrec :: ReadPrec EnterStandbyResponse

readListPrec :: ReadPrec [EnterStandbyResponse]

Show EnterStandbyResponse

Defined in Amazonka.AutoScaling.EnterStandby

Methods

showsPrec :: Int -> EnterStandbyResponse -> ShowS

show :: EnterStandbyResponse -> String

showList :: [EnterStandbyResponse] -> ShowS

NFData EnterStandbyResponse

Defined in Amazonka.AutoScaling.EnterStandby

Methods

rnf :: EnterStandbyResponse -> ()

Eq EnterStandbyResponse

Defined in Amazonka.AutoScaling.EnterStandby

Methods

(==) :: EnterStandbyResponse -> EnterStandbyResponse -> Bool

(/=) :: EnterStandbyResponse -> EnterStandbyResponse -> Bool

type Rep EnterStandbyResponse

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

Arguments

:: Int

$sel:httpStatus:EnterStandbyResponse'

-> EnterStandbyResponse

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])

The activities related to moving instances into Standby mode.

enterStandbyResponse_httpStatus :: Lens' EnterStandbyResponse Int

The response's http status code.