Amazonka.AutoScaling.DetachInstances

Removes one or more instances from the specified Auto Scaling group.

After the instances are detached, you can manage them independent of the Auto Scaling group.

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

If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.

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

Creating a Request

data DetachInstances

See: newDetachInstances smart constructor.

Constructors

DetachInstances'

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 the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Instances

ToHeaders DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

toHeaders :: DetachInstances -> [Header]

ToPath DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

toPath :: DetachInstances -> ByteString

ToQuery DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

toQuery :: DetachInstances -> QueryString

AWSRequest DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Associated Types

type AWSResponse DetachInstances

Methods

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

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

Generic DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Associated Types

type Rep DetachInstances :: Type -> Type

Methods

from :: DetachInstances -> Rep DetachInstances x

to :: Rep DetachInstances x -> DetachInstances

Read DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

readsPrec :: Int -> ReadS DetachInstances

readList :: ReadS [DetachInstances]

readPrec :: ReadPrec DetachInstances

readListPrec :: ReadPrec [DetachInstances]

Show DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

showsPrec :: Int -> DetachInstances -> ShowS

show :: DetachInstances -> String

showList :: [DetachInstances] -> ShowS

NFData DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

rnf :: DetachInstances -> ()

Eq DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

(==) :: DetachInstances -> DetachInstances -> Bool

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

Hashable DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

Methods

hashWithSalt :: Int -> DetachInstances -> Int

hash :: DetachInstances -> Int

type AWSResponse DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

type AWSResponse DetachInstances = DetachInstancesResponse

type Rep DetachInstances

Defined in Amazonka.AutoScaling.DetachInstances

type Rep DetachInstances = D1 ('MetaData "DetachInstances" "Amazonka.AutoScaling.DetachInstances" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "DetachInstances'" '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))))

newDetachInstances

Arguments

:: Text

DetachInstances

-> Bool

$sel:shouldDecrementDesiredCapacity:DetachInstances'

-> DetachInstances

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

DetachInstances, detachInstances_autoScalingGroupName - The name of the Auto Scaling group.

$sel:shouldDecrementDesiredCapacity:DetachInstances', detachInstances_shouldDecrementDesiredCapacity - Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Request Lenses

detachInstances_instanceIds :: Lens' DetachInstances (Maybe [Text])

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

detachInstances_autoScalingGroupName :: Lens' DetachInstances Text

The name of the Auto Scaling group.

detachInstances_shouldDecrementDesiredCapacity :: Lens' DetachInstances Bool

Indicates whether the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Destructuring the Response

data DetachInstancesResponse

See: newDetachInstancesResponse smart constructor.

Constructors

DetachInstancesResponse'

Fields

• activities :: Maybe [Activity]

  The activities related to detaching the instances from the Auto Scaling group.

• httpStatus :: Int

  The response's http status code.

Instances

Generic DetachInstancesResponse

Defined in Amazonka.AutoScaling.DetachInstances

Associated Types

type Rep DetachInstancesResponse :: Type -> Type

Methods

from :: DetachInstancesResponse -> Rep DetachInstancesResponse x

to :: Rep DetachInstancesResponse x -> DetachInstancesResponse

Read DetachInstancesResponse

Defined in Amazonka.AutoScaling.DetachInstances

Methods

readsPrec :: Int -> ReadS DetachInstancesResponse

readList :: ReadS [DetachInstancesResponse]

readPrec :: ReadPrec DetachInstancesResponse

readListPrec :: ReadPrec [DetachInstancesResponse]

Show DetachInstancesResponse

Defined in Amazonka.AutoScaling.DetachInstances

Methods

showsPrec :: Int -> DetachInstancesResponse -> ShowS

show :: DetachInstancesResponse -> String

showList :: [DetachInstancesResponse] -> ShowS

NFData DetachInstancesResponse

Defined in Amazonka.AutoScaling.DetachInstances

Methods

rnf :: DetachInstancesResponse -> ()

Eq DetachInstancesResponse

Defined in Amazonka.AutoScaling.DetachInstances

Methods

(==) :: DetachInstancesResponse -> DetachInstancesResponse -> Bool

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

type Rep DetachInstancesResponse

Defined in Amazonka.AutoScaling.DetachInstances

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

newDetachInstancesResponse

Arguments

:: Int

$sel:httpStatus:DetachInstancesResponse'

-> DetachInstancesResponse

Create a value of DetachInstancesResponse 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:DetachInstancesResponse', detachInstancesResponse_activities - The activities related to detaching the instances from the Auto Scaling group.

$sel:httpStatus:DetachInstancesResponse', detachInstancesResponse_httpStatus - The response's http status code.

Response Lenses

detachInstancesResponse_activities :: Lens' DetachInstancesResponse (Maybe [Activity])

The activities related to detaching the instances from the Auto Scaling group.

detachInstancesResponse_httpStatus :: Lens' DetachInstancesResponse Int

The response's http status code.