amazonka-autoscaling-1.6.0: Amazon Auto Scaling SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.AutoScaling.SetInstanceHealth

Contents

Description

Sets the health status of the specified instance.

For more information, see Health Checks in the Auto Scaling User Guide .

Synopsis

Creating a Request

setInstanceHealth #

Creates a value of SetInstanceHealth with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • sihShouldRespectGracePeriod - If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False , if you do not want the call to respect the grace period associated with the group. For more information, see the description of the health check grace period for CreateAutoScalingGroup .
  • sihInstanceId - The ID of the instance.
  • sihHealthStatus - The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

data SetInstanceHealth #

See: setInstanceHealth smart constructor.

Instances

Eq SetInstanceHealth # 
Data SetInstanceHealth # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetInstanceHealth -> c SetInstanceHealth #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetInstanceHealth #

toConstr :: SetInstanceHealth -> Constr #

dataTypeOf :: SetInstanceHealth -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetInstanceHealth) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetInstanceHealth) #

gmapT :: (forall b. Data b => b -> b) -> SetInstanceHealth -> SetInstanceHealth #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetInstanceHealth -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetInstanceHealth -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetInstanceHealth -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetInstanceHealth -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetInstanceHealth -> m SetInstanceHealth #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetInstanceHealth -> m SetInstanceHealth #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetInstanceHealth -> m SetInstanceHealth #

Read SetInstanceHealth # 
Show SetInstanceHealth # 
Generic SetInstanceHealth # 
Hashable SetInstanceHealth # 
NFData SetInstanceHealth # 

Methods

rnf :: SetInstanceHealth -> () #

AWSRequest SetInstanceHealth # 
ToHeaders SetInstanceHealth # 
ToPath SetInstanceHealth # 
ToQuery SetInstanceHealth # 
type Rep SetInstanceHealth # 
type Rep SetInstanceHealth = D1 * (MetaData "SetInstanceHealth" "Network.AWS.AutoScaling.SetInstanceHealth" "amazonka-autoscaling-1.6.0-DMznPeeRJvH7GRIPsqcJh1" False) (C1 * (MetaCons "SetInstanceHealth'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_sihShouldRespectGracePeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_sihInstanceId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_sihHealthStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)))))
type Rs SetInstanceHealth # 

Request Lenses

sihShouldRespectGracePeriod :: Lens' SetInstanceHealth (Maybe Bool) #

If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod specified for the group, by default, this call will respect the grace period. Set this to False , if you do not want the call to respect the grace period associated with the group. For more information, see the description of the health check grace period for CreateAutoScalingGroup .

sihInstanceId :: Lens' SetInstanceHealth Text #

The ID of the instance.

sihHealthStatus :: Lens' SetInstanceHealth Text #

The health status of the instance. Set to Healthy if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

Destructuring the Response

setInstanceHealthResponse :: SetInstanceHealthResponse #

Creates a value of SetInstanceHealthResponse with the minimum fields required to make a request.

data SetInstanceHealthResponse #

See: setInstanceHealthResponse smart constructor.

Instances

Eq SetInstanceHealthResponse # 
Data SetInstanceHealthResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> SetInstanceHealthResponse -> c SetInstanceHealthResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c SetInstanceHealthResponse #

toConstr :: SetInstanceHealthResponse -> Constr #

dataTypeOf :: SetInstanceHealthResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c SetInstanceHealthResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c SetInstanceHealthResponse) #

gmapT :: (forall b. Data b => b -> b) -> SetInstanceHealthResponse -> SetInstanceHealthResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> SetInstanceHealthResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> SetInstanceHealthResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> SetInstanceHealthResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> SetInstanceHealthResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> SetInstanceHealthResponse -> m SetInstanceHealthResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> SetInstanceHealthResponse -> m SetInstanceHealthResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> SetInstanceHealthResponse -> m SetInstanceHealthResponse #

Read SetInstanceHealthResponse # 
Show SetInstanceHealthResponse # 
Generic SetInstanceHealthResponse # 
NFData SetInstanceHealthResponse # 
type Rep SetInstanceHealthResponse # 
type Rep SetInstanceHealthResponse = D1 * (MetaData "SetInstanceHealthResponse" "Network.AWS.AutoScaling.SetInstanceHealth" "amazonka-autoscaling-1.6.0-DMznPeeRJvH7GRIPsqcJh1" False) (C1 * (MetaCons "SetInstanceHealthResponse'" PrefixI False) (U1 *))