Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Terminates the specified instance and optionally adjusts the desired group size. This operation cannot be called on instances in a warm pool.

This call simply makes a termination request. The instance is not terminated immediately. When an instance is terminated, the instance status changes to terminated. You can't connect to or start an instance after you've terminated it.

If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches instances to replace the ones that are terminated.

By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you decrement the desired capacity, your Auto Scaling group can become unbalanced between Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.

Synopsis

data TerminateInstanceInAutoScalingGroup = TerminateInstanceInAutoScalingGroup' {
- instanceId :: Text
- shouldDecrementDesiredCapacity :: Bool
}
newTerminateInstanceInAutoScalingGroup :: Text -> Bool -> TerminateInstanceInAutoScalingGroup
terminateInstanceInAutoScalingGroup_instanceId :: Lens' TerminateInstanceInAutoScalingGroup Text
terminateInstanceInAutoScalingGroup_shouldDecrementDesiredCapacity :: Lens' TerminateInstanceInAutoScalingGroup Bool
data TerminateInstanceInAutoScalingGroupResponse = TerminateInstanceInAutoScalingGroupResponse' {
- activity :: Maybe Activity
- httpStatus :: Int
}
newTerminateInstanceInAutoScalingGroupResponse :: Int -> TerminateInstanceInAutoScalingGroupResponse
terminateInstanceInAutoScalingGroupResponse_activity :: Lens' TerminateInstanceInAutoScalingGroupResponse (Maybe Activity)
terminateInstanceInAutoScalingGroupResponse_httpStatus :: Lens' TerminateInstanceInAutoScalingGroupResponse Int

Creating a Request

data TerminateInstanceInAutoScalingGroup Source #

See: newTerminateInstanceInAutoScalingGroup smart constructor.

Constructors

TerminateInstanceInAutoScalingGroup'
Fields instanceId :: Text The ID of the instance. shouldDecrementDesiredCapacity :: Bool Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

Instances

Instances details

Eq TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods (==) :: TerminateInstanceInAutoScalingGroup -> TerminateInstanceInAutoScalingGroup -> Bool # (/=) :: TerminateInstanceInAutoScalingGroup -> TerminateInstanceInAutoScalingGroup -> Bool #
Read TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods readsPrec :: Int -> ReadS TerminateInstanceInAutoScalingGroup # readList :: ReadS [TerminateInstanceInAutoScalingGroup] # readPrec :: ReadPrec TerminateInstanceInAutoScalingGroup # readListPrec :: ReadPrec [TerminateInstanceInAutoScalingGroup] #
Show TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods showsPrec :: Int -> TerminateInstanceInAutoScalingGroup -> ShowS # show :: TerminateInstanceInAutoScalingGroup -> String # showList :: [TerminateInstanceInAutoScalingGroup] -> ShowS #
Generic TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Associated Types type Rep TerminateInstanceInAutoScalingGroup :: Type -> Type # Methods from :: TerminateInstanceInAutoScalingGroup -> Rep TerminateInstanceInAutoScalingGroup x # to :: Rep TerminateInstanceInAutoScalingGroup x -> TerminateInstanceInAutoScalingGroup #
NFData TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods rnf :: TerminateInstanceInAutoScalingGroup -> () #
Hashable TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods hashWithSalt :: Int -> TerminateInstanceInAutoScalingGroup -> Int # hash :: TerminateInstanceInAutoScalingGroup -> Int #
AWSRequest TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Associated Types type AWSResponse TerminateInstanceInAutoScalingGroup # Methods request :: TerminateInstanceInAutoScalingGroup -> Request TerminateInstanceInAutoScalingGroup # response :: MonadResource m => Logger -> Service -> Proxy TerminateInstanceInAutoScalingGroup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TerminateInstanceInAutoScalingGroup))) #
ToHeaders TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods toHeaders :: TerminateInstanceInAutoScalingGroup -> [Header] #
ToPath TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods toPath :: TerminateInstanceInAutoScalingGroup -> ByteString #
ToQuery TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods toQuery :: TerminateInstanceInAutoScalingGroup -> QueryString #
type Rep TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup type Rep TerminateInstanceInAutoScalingGroup = D1 ('MetaData "TerminateInstanceInAutoScalingGroup" "Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "TerminateInstanceInAutoScalingGroup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "instanceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "shouldDecrementDesiredCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))
type AWSResponse TerminateInstanceInAutoScalingGroup Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup type AWSResponse TerminateInstanceInAutoScalingGroup = TerminateInstanceInAutoScalingGroupResponse

newTerminateInstanceInAutoScalingGroup Source #

Arguments

:: Text	`$sel:instanceId:TerminateInstanceInAutoScalingGroup'`
-> Bool	`$sel:shouldDecrementDesiredCapacity:TerminateInstanceInAutoScalingGroup'`
-> TerminateInstanceInAutoScalingGroup

Create a value of TerminateInstanceInAutoScalingGroup 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:instanceId:TerminateInstanceInAutoScalingGroup', terminateInstanceInAutoScalingGroup_instanceId - The ID of the instance.

$sel:shouldDecrementDesiredCapacity:TerminateInstanceInAutoScalingGroup', terminateInstanceInAutoScalingGroup_shouldDecrementDesiredCapacity - Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

Request Lenses

terminateInstanceInAutoScalingGroup_instanceId :: Lens' TerminateInstanceInAutoScalingGroup Text Source #

The ID of the instance.

terminateInstanceInAutoScalingGroup_shouldDecrementDesiredCapacity :: Lens' TerminateInstanceInAutoScalingGroup Bool Source #

Indicates whether terminating the instance also decrements the size of the Auto Scaling group.

Destructuring the Response

data TerminateInstanceInAutoScalingGroupResponse Source #

See: newTerminateInstanceInAutoScalingGroupResponse smart constructor.

Constructors

TerminateInstanceInAutoScalingGroupResponse'
Fields activity :: Maybe Activity A scaling activity. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq TerminateInstanceInAutoScalingGroupResponse Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods (==) :: TerminateInstanceInAutoScalingGroupResponse -> TerminateInstanceInAutoScalingGroupResponse -> Bool # (/=) :: TerminateInstanceInAutoScalingGroupResponse -> TerminateInstanceInAutoScalingGroupResponse -> Bool #
Read TerminateInstanceInAutoScalingGroupResponse Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods readsPrec :: Int -> ReadS TerminateInstanceInAutoScalingGroupResponse # readList :: ReadS [TerminateInstanceInAutoScalingGroupResponse] # readPrec :: ReadPrec TerminateInstanceInAutoScalingGroupResponse # readListPrec :: ReadPrec [TerminateInstanceInAutoScalingGroupResponse] #
Show TerminateInstanceInAutoScalingGroupResponse Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods showsPrec :: Int -> TerminateInstanceInAutoScalingGroupResponse -> ShowS # show :: TerminateInstanceInAutoScalingGroupResponse -> String # showList :: [TerminateInstanceInAutoScalingGroupResponse] -> ShowS #
Generic TerminateInstanceInAutoScalingGroupResponse Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Associated Types type Rep TerminateInstanceInAutoScalingGroupResponse :: Type -> Type # Methods from :: TerminateInstanceInAutoScalingGroupResponse -> Rep TerminateInstanceInAutoScalingGroupResponse x # to :: Rep TerminateInstanceInAutoScalingGroupResponse x -> TerminateInstanceInAutoScalingGroupResponse #
NFData TerminateInstanceInAutoScalingGroupResponse Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup Methods rnf :: TerminateInstanceInAutoScalingGroupResponse -> () #
type Rep TerminateInstanceInAutoScalingGroupResponse Source #
Instance details Defined in Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup type Rep TerminateInstanceInAutoScalingGroupResponse = D1 ('MetaData "TerminateInstanceInAutoScalingGroupResponse" "Amazonka.AutoScaling.TerminateInstanceInAutoScalingGroup" "libZSservicesZSamazonka-autoscalingZSamazonka-autoscaling" 'False) (C1 ('MetaCons "TerminateInstanceInAutoScalingGroupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "activity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Activity)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newTerminateInstanceInAutoScalingGroupResponse Source #

Arguments

:: Int	`$sel:httpStatus:TerminateInstanceInAutoScalingGroupResponse'`
-> TerminateInstanceInAutoScalingGroupResponse

Create a value of TerminateInstanceInAutoScalingGroupResponse 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:activity:TerminateInstanceInAutoScalingGroupResponse', terminateInstanceInAutoScalingGroupResponse_activity - A scaling activity.

$sel:httpStatus:TerminateInstanceInAutoScalingGroupResponse', terminateInstanceInAutoScalingGroupResponse_httpStatus - The response's http status code.

Response Lenses

terminateInstanceInAutoScalingGroupResponse_activity :: Lens' TerminateInstanceInAutoScalingGroupResponse (Maybe Activity) Source #

A scaling activity.

terminateInstanceInAutoScalingGroupResponse_httpStatus :: Lens' TerminateInstanceInAutoScalingGroupResponse Int Source #

The response's http status code.