amazonka-autoscaling-1.2.0: Amazon Auto Scaling SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@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 Developer Guide.

See: AWS API Reference for SetInstanceHealth.

Synopsis

Creating a Request

setInstanceHealth Source

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:

Request Lenses

sihShouldRespectGracePeriod :: 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 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 HealthCheckGracePeriod parameter description for CreateAutoScalingGroup.

sihInstanceId :: Lens' SetInstanceHealth Text Source

The ID of the EC2 instance.

sihHealthStatus :: Lens' SetInstanceHealth Text Source

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 Source

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