Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AutoScaling.SetInstanceHealth

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Sets the health status of the specified instance.

For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.

Creating a Request

data SetInstanceHealth Source #

See: newSetInstanceHealth smart constructor.

Constructors

SetInstanceHealth'

Fields

shouldRespectGracePeriod :: Maybe Bool
If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.
For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.
instanceId :: Text
The ID of the instance.
healthStatus :: Text
The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

Instances

Instances details

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

newSetInstanceHealth Source #

Arguments

:: Text	`SetInstanceHealth`
-> Text	`SetInstanceHealth`
-> SetInstanceHealth

Create a value of SetInstanceHealth 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:shouldRespectGracePeriod:SetInstanceHealth', setInstanceHealth_shouldRespectGracePeriod - If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.

SetInstanceHealth, setInstanceHealth_instanceId - The ID of the instance.

SetInstanceHealth, setInstanceHealth_healthStatus - The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

Request Lenses

setInstanceHealth_shouldRespectGracePeriod :: Lens' SetInstanceHealth (Maybe Bool) Source #

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call respects the grace period. Set this to False, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup in the Amazon EC2 Auto Scaling API Reference.

setInstanceHealth_instanceId :: Lens' SetInstanceHealth Text Source #

The ID of the instance.

setInstanceHealth_healthStatus :: Lens' SetInstanceHealth Text Source #

The health status of the instance. Set to Healthy to have the instance remain in service. Set to Unhealthy to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

Destructuring the Response

data SetInstanceHealthResponse Source #

See: newSetInstanceHealthResponse smart constructor.

Constructors

SetInstanceHealthResponse'

Instances

Instances details

Generic SetInstanceHealthResponse Source #
Instance details Defined in Amazonka.AutoScaling.SetInstanceHealth Associated Types type Rep SetInstanceHealthResponse :: Type -> Type # Methods from :: SetInstanceHealthResponse -> Rep SetInstanceHealthResponse x # to :: Rep SetInstanceHealthResponse x -> SetInstanceHealthResponse #
Read SetInstanceHealthResponse Source #
Instance details Defined in Amazonka.AutoScaling.SetInstanceHealth Methods readsPrec :: Int -> ReadS SetInstanceHealthResponse # readList :: ReadS [SetInstanceHealthResponse] # readPrec :: ReadPrec SetInstanceHealthResponse # readListPrec :: ReadPrec [SetInstanceHealthResponse] #
Show SetInstanceHealthResponse Source #
Instance details Defined in Amazonka.AutoScaling.SetInstanceHealth Methods showsPrec :: Int -> SetInstanceHealthResponse -> ShowS # show :: SetInstanceHealthResponse -> String # showList :: [SetInstanceHealthResponse] -> ShowS #
NFData SetInstanceHealthResponse Source #
Instance details Defined in Amazonka.AutoScaling.SetInstanceHealth Methods rnf :: SetInstanceHealthResponse -> () #
Eq SetInstanceHealthResponse Source #
Instance details Defined in Amazonka.AutoScaling.SetInstanceHealth Methods (==) :: SetInstanceHealthResponse -> SetInstanceHealthResponse -> Bool # (/=) :: SetInstanceHealthResponse -> SetInstanceHealthResponse -> Bool #
type Rep SetInstanceHealthResponse Source #
Instance details Defined in Amazonka.AutoScaling.SetInstanceHealth type Rep SetInstanceHealthResponse = D1 ('MetaData "SetInstanceHealthResponse" "Amazonka.AutoScaling.SetInstanceHealth" "amazonka-autoscaling-2.0-IerpHfP4BA3Ir4ZL2IR1De" 'False) (C1 ('MetaCons "SetInstanceHealthResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newSetInstanceHealthResponse :: SetInstanceHealthResponse Source #

Create a value of SetInstanceHealthResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.