{-# 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.OpsWorks.StopInstance
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Stops a specified instance. When you stop a standard instance, the data
-- disappears and must be reinstalled when you restart the instance. You
-- can stop an Amazon EBS-backed instance without losing data. For more
-- information, see
-- <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html Starting, Stopping, and Rebooting Instances>.
--
-- __Required Permissions__: To use this action, an IAM user must have a
-- Manage permissions level for the stack, or an attached policy that
-- explicitly grants permissions. For more information on user permissions,
-- see
-- <https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html Managing User Permissions>.
module Amazonka.OpsWorks.StopInstance
  ( -- * Creating a Request
    StopInstance (..),
    newStopInstance,

    -- * Request Lenses
    stopInstance_force,
    stopInstance_instanceId,

    -- * Destructuring the Response
    StopInstanceResponse (..),
    newStopInstanceResponse,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import Amazonka.OpsWorks.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newStopInstance' smart constructor.
data StopInstance = StopInstance'
  { -- | Specifies whether to force an instance to stop. If the instance\'s root
    -- device type is @ebs@, or EBS-backed, adding the @Force@ parameter to the
    -- @StopInstances@ API call disassociates the AWS OpsWorks Stacks instance
    -- from EC2, and forces deletion of /only/ the OpsWorks Stacks instance.
    -- You must also delete the formerly-associated instance in EC2 after
    -- troubleshooting and replacing the AWS OpsWorks Stacks instance with a
    -- new one.
    StopInstance -> Maybe Bool
force :: Prelude.Maybe Prelude.Bool,
    -- | The instance ID.
    StopInstance -> Text
instanceId :: Prelude.Text
  }
  deriving (StopInstance -> StopInstance -> Bool
(StopInstance -> StopInstance -> Bool)
-> (StopInstance -> StopInstance -> Bool) -> Eq StopInstance
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StopInstance -> StopInstance -> Bool
$c/= :: StopInstance -> StopInstance -> Bool
== :: StopInstance -> StopInstance -> Bool
$c== :: StopInstance -> StopInstance -> Bool
Prelude.Eq, ReadPrec [StopInstance]
ReadPrec StopInstance
Int -> ReadS StopInstance
ReadS [StopInstance]
(Int -> ReadS StopInstance)
-> ReadS [StopInstance]
-> ReadPrec StopInstance
-> ReadPrec [StopInstance]
-> Read StopInstance
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StopInstance]
$creadListPrec :: ReadPrec [StopInstance]
readPrec :: ReadPrec StopInstance
$creadPrec :: ReadPrec StopInstance
readList :: ReadS [StopInstance]
$creadList :: ReadS [StopInstance]
readsPrec :: Int -> ReadS StopInstance
$creadsPrec :: Int -> ReadS StopInstance
Prelude.Read, Int -> StopInstance -> ShowS
[StopInstance] -> ShowS
StopInstance -> String
(Int -> StopInstance -> ShowS)
-> (StopInstance -> String)
-> ([StopInstance] -> ShowS)
-> Show StopInstance
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StopInstance] -> ShowS
$cshowList :: [StopInstance] -> ShowS
show :: StopInstance -> String
$cshow :: StopInstance -> String
showsPrec :: Int -> StopInstance -> ShowS
$cshowsPrec :: Int -> StopInstance -> ShowS
Prelude.Show, (forall x. StopInstance -> Rep StopInstance x)
-> (forall x. Rep StopInstance x -> StopInstance)
-> Generic StopInstance
forall x. Rep StopInstance x -> StopInstance
forall x. StopInstance -> Rep StopInstance x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StopInstance x -> StopInstance
$cfrom :: forall x. StopInstance -> Rep StopInstance x
Prelude.Generic)

-- |
-- Create a value of 'StopInstance' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'force', 'stopInstance_force' - Specifies whether to force an instance to stop. If the instance\'s root
-- device type is @ebs@, or EBS-backed, adding the @Force@ parameter to the
-- @StopInstances@ API call disassociates the AWS OpsWorks Stacks instance
-- from EC2, and forces deletion of /only/ the OpsWorks Stacks instance.
-- You must also delete the formerly-associated instance in EC2 after
-- troubleshooting and replacing the AWS OpsWorks Stacks instance with a
-- new one.
--
-- 'instanceId', 'stopInstance_instanceId' - The instance ID.
newStopInstance ::
  -- | 'instanceId'
  Prelude.Text ->
  StopInstance
newStopInstance :: Text -> StopInstance
newStopInstance Text
pInstanceId_ =
  StopInstance' :: Maybe Bool -> Text -> StopInstance
StopInstance'
    { $sel:force:StopInstance' :: Maybe Bool
force = Maybe Bool
forall a. Maybe a
Prelude.Nothing,
      $sel:instanceId:StopInstance' :: Text
instanceId = Text
pInstanceId_
    }

-- | Specifies whether to force an instance to stop. If the instance\'s root
-- device type is @ebs@, or EBS-backed, adding the @Force@ parameter to the
-- @StopInstances@ API call disassociates the AWS OpsWorks Stacks instance
-- from EC2, and forces deletion of /only/ the OpsWorks Stacks instance.
-- You must also delete the formerly-associated instance in EC2 after
-- troubleshooting and replacing the AWS OpsWorks Stacks instance with a
-- new one.
stopInstance_force :: Lens.Lens' StopInstance (Prelude.Maybe Prelude.Bool)
stopInstance_force :: (Maybe Bool -> f (Maybe Bool)) -> StopInstance -> f StopInstance
stopInstance_force = (StopInstance -> Maybe Bool)
-> (StopInstance -> Maybe Bool -> StopInstance)
-> Lens StopInstance StopInstance (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StopInstance' {Maybe Bool
force :: Maybe Bool
$sel:force:StopInstance' :: StopInstance -> Maybe Bool
force} -> Maybe Bool
force) (\s :: StopInstance
s@StopInstance' {} Maybe Bool
a -> StopInstance
s {$sel:force:StopInstance' :: Maybe Bool
force = Maybe Bool
a} :: StopInstance)

-- | The instance ID.
stopInstance_instanceId :: Lens.Lens' StopInstance Prelude.Text
stopInstance_instanceId :: (Text -> f Text) -> StopInstance -> f StopInstance
stopInstance_instanceId = (StopInstance -> Text)
-> (StopInstance -> Text -> StopInstance)
-> Lens StopInstance StopInstance Text Text
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\StopInstance' {Text
instanceId :: Text
$sel:instanceId:StopInstance' :: StopInstance -> Text
instanceId} -> Text
instanceId) (\s :: StopInstance
s@StopInstance' {} Text
a -> StopInstance
s {$sel:instanceId:StopInstance' :: Text
instanceId = Text
a} :: StopInstance)

instance Core.AWSRequest StopInstance where
  type AWSResponse StopInstance = StopInstanceResponse
  request :: StopInstance -> Request StopInstance
request = Service -> StopInstance -> Request StopInstance
forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON Service
defaultService
  response :: Logger
-> Service
-> Proxy StopInstance
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse StopInstance)))
response = AWSResponse StopInstance
-> Logger
-> Service
-> Proxy StopInstance
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse StopInstance)))
forall (m :: * -> *) a.
MonadResource m =>
AWSResponse a
-> Logger
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveNull AWSResponse StopInstance
StopInstanceResponse
StopInstanceResponse'

instance Prelude.Hashable StopInstance

instance Prelude.NFData StopInstance

instance Core.ToHeaders StopInstance where
  toHeaders :: StopInstance -> [Header]
toHeaders =
    [Header] -> StopInstance -> [Header]
forall a b. a -> b -> a
Prelude.const
      ( [[Header]] -> [Header]
forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"X-Amz-Target"
              HeaderName -> ByteString -> [Header]
forall a. ToHeader a => HeaderName -> a -> [Header]
Core.=# ( ByteString
"OpsWorks_20130218.StopInstance" ::
                          Prelude.ByteString
                      ),
            HeaderName
"Content-Type"
              HeaderName -> ByteString -> [Header]
forall a. ToHeader a => HeaderName -> a -> [Header]
Core.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Core.ToJSON StopInstance where
  toJSON :: StopInstance -> Value
toJSON StopInstance' {Maybe Bool
Text
instanceId :: Text
force :: Maybe Bool
$sel:instanceId:StopInstance' :: StopInstance -> Text
$sel:force:StopInstance' :: StopInstance -> Maybe Bool
..} =
    [Pair] -> Value
Core.object
      ( [Maybe Pair] -> [Pair]
forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Text
"Force" Text -> Bool -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..=) (Bool -> Pair) -> Maybe Bool -> Maybe Pair
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Bool
force,
            Pair -> Maybe Pair
forall a. a -> Maybe a
Prelude.Just (Text
"InstanceId" Text -> Text -> Pair
forall kv v. (KeyValue kv, ToJSON v) => Text -> v -> kv
Core..= Text
instanceId)
          ]
      )

instance Core.ToPath StopInstance where
  toPath :: StopInstance -> ByteString
toPath = ByteString -> StopInstance -> ByteString
forall a b. a -> b -> a
Prelude.const ByteString
"/"

instance Core.ToQuery StopInstance where
  toQuery :: StopInstance -> QueryString
toQuery = QueryString -> StopInstance -> QueryString
forall a b. a -> b -> a
Prelude.const QueryString
forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newStopInstanceResponse' smart constructor.
data StopInstanceResponse = StopInstanceResponse'
  {
  }
  deriving (StopInstanceResponse -> StopInstanceResponse -> Bool
(StopInstanceResponse -> StopInstanceResponse -> Bool)
-> (StopInstanceResponse -> StopInstanceResponse -> Bool)
-> Eq StopInstanceResponse
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: StopInstanceResponse -> StopInstanceResponse -> Bool
$c/= :: StopInstanceResponse -> StopInstanceResponse -> Bool
== :: StopInstanceResponse -> StopInstanceResponse -> Bool
$c== :: StopInstanceResponse -> StopInstanceResponse -> Bool
Prelude.Eq, ReadPrec [StopInstanceResponse]
ReadPrec StopInstanceResponse
Int -> ReadS StopInstanceResponse
ReadS [StopInstanceResponse]
(Int -> ReadS StopInstanceResponse)
-> ReadS [StopInstanceResponse]
-> ReadPrec StopInstanceResponse
-> ReadPrec [StopInstanceResponse]
-> Read StopInstanceResponse
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [StopInstanceResponse]
$creadListPrec :: ReadPrec [StopInstanceResponse]
readPrec :: ReadPrec StopInstanceResponse
$creadPrec :: ReadPrec StopInstanceResponse
readList :: ReadS [StopInstanceResponse]
$creadList :: ReadS [StopInstanceResponse]
readsPrec :: Int -> ReadS StopInstanceResponse
$creadsPrec :: Int -> ReadS StopInstanceResponse
Prelude.Read, Int -> StopInstanceResponse -> ShowS
[StopInstanceResponse] -> ShowS
StopInstanceResponse -> String
(Int -> StopInstanceResponse -> ShowS)
-> (StopInstanceResponse -> String)
-> ([StopInstanceResponse] -> ShowS)
-> Show StopInstanceResponse
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [StopInstanceResponse] -> ShowS
$cshowList :: [StopInstanceResponse] -> ShowS
show :: StopInstanceResponse -> String
$cshow :: StopInstanceResponse -> String
showsPrec :: Int -> StopInstanceResponse -> ShowS
$cshowsPrec :: Int -> StopInstanceResponse -> ShowS
Prelude.Show, (forall x. StopInstanceResponse -> Rep StopInstanceResponse x)
-> (forall x. Rep StopInstanceResponse x -> StopInstanceResponse)
-> Generic StopInstanceResponse
forall x. Rep StopInstanceResponse x -> StopInstanceResponse
forall x. StopInstanceResponse -> Rep StopInstanceResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep StopInstanceResponse x -> StopInstanceResponse
$cfrom :: forall x. StopInstanceResponse -> Rep StopInstanceResponse x
Prelude.Generic)

-- |
-- Create a value of 'StopInstanceResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
newStopInstanceResponse ::
  StopInstanceResponse
newStopInstanceResponse :: StopInstanceResponse
newStopInstanceResponse = StopInstanceResponse
StopInstanceResponse'

instance Prelude.NFData StopInstanceResponse