{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.AutoScaling.SetInstanceHealth -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Sets the health status of the specified instance. -- -- For more information, see -- -- in the /Amazon EC2 Auto Scaling User Guide/. module Amazonka.AutoScaling.SetInstanceHealth ( -- * Creating a Request SetInstanceHealth (..), newSetInstanceHealth, -- * Request Lenses setInstanceHealth_shouldRespectGracePeriod, setInstanceHealth_instanceId, setInstanceHealth_healthStatus, -- * Destructuring the Response SetInstanceHealthResponse (..), newSetInstanceHealthResponse, ) where import Amazonka.AutoScaling.Types import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newSetInstanceHealth' smart constructor. data SetInstanceHealth = SetInstanceHealth' { -- | 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 -- -- in the /Amazon EC2 Auto Scaling API Reference/. shouldRespectGracePeriod :: Prelude.Maybe Prelude.Bool, -- | The ID of the instance. instanceId :: Prelude.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. healthStatus :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'SetInstanceHealth' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'shouldRespectGracePeriod', '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 -- -- in the /Amazon EC2 Auto Scaling API Reference/. -- -- 'instanceId', 'setInstanceHealth_instanceId' - The ID of the instance. -- -- 'healthStatus', '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. newSetInstanceHealth :: -- | 'instanceId' Prelude.Text -> -- | 'healthStatus' Prelude.Text -> SetInstanceHealth newSetInstanceHealth pInstanceId_ pHealthStatus_ = SetInstanceHealth' { shouldRespectGracePeriod = Prelude.Nothing, instanceId = pInstanceId_, healthStatus = pHealthStatus_ } -- | 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 -- -- in the /Amazon EC2 Auto Scaling API Reference/. setInstanceHealth_shouldRespectGracePeriod :: Lens.Lens' SetInstanceHealth (Prelude.Maybe Prelude.Bool) setInstanceHealth_shouldRespectGracePeriod = Lens.lens (\SetInstanceHealth' {shouldRespectGracePeriod} -> shouldRespectGracePeriod) (\s@SetInstanceHealth' {} a -> s {shouldRespectGracePeriod = a} :: SetInstanceHealth) -- | The ID of the instance. setInstanceHealth_instanceId :: Lens.Lens' SetInstanceHealth Prelude.Text setInstanceHealth_instanceId = Lens.lens (\SetInstanceHealth' {instanceId} -> instanceId) (\s@SetInstanceHealth' {} a -> s {instanceId = a} :: SetInstanceHealth) -- | 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. setInstanceHealth_healthStatus :: Lens.Lens' SetInstanceHealth Prelude.Text setInstanceHealth_healthStatus = Lens.lens (\SetInstanceHealth' {healthStatus} -> healthStatus) (\s@SetInstanceHealth' {} a -> s {healthStatus = a} :: SetInstanceHealth) instance Core.AWSRequest SetInstanceHealth where type AWSResponse SetInstanceHealth = SetInstanceHealthResponse request overrides = Request.postQuery (overrides defaultService) response = Response.receiveNull SetInstanceHealthResponse' instance Prelude.Hashable SetInstanceHealth where hashWithSalt _salt SetInstanceHealth' {..} = _salt `Prelude.hashWithSalt` shouldRespectGracePeriod `Prelude.hashWithSalt` instanceId `Prelude.hashWithSalt` healthStatus instance Prelude.NFData SetInstanceHealth where rnf SetInstanceHealth' {..} = Prelude.rnf shouldRespectGracePeriod `Prelude.seq` Prelude.rnf instanceId `Prelude.seq` Prelude.rnf healthStatus instance Data.ToHeaders SetInstanceHealth where toHeaders = Prelude.const Prelude.mempty instance Data.ToPath SetInstanceHealth where toPath = Prelude.const "/" instance Data.ToQuery SetInstanceHealth where toQuery SetInstanceHealth' {..} = Prelude.mconcat [ "Action" Data.=: ("SetInstanceHealth" :: Prelude.ByteString), "Version" Data.=: ("2011-01-01" :: Prelude.ByteString), "ShouldRespectGracePeriod" Data.=: shouldRespectGracePeriod, "InstanceId" Data.=: instanceId, "HealthStatus" Data.=: healthStatus ] -- | /See:/ 'newSetInstanceHealthResponse' smart constructor. data SetInstanceHealthResponse = SetInstanceHealthResponse' { } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'SetInstanceHealthResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. newSetInstanceHealthResponse :: SetInstanceHealthResponse newSetInstanceHealthResponse = SetInstanceHealthResponse' instance Prelude.NFData SetInstanceHealthResponse where rnf _ = ()