{-# 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.OpsWorksCM.RestoreServer
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Restores a backup to a server that is in a @CONNECTION_LOST@, @HEALTHY@,
-- @RUNNING@, @UNHEALTHY@, or @TERMINATED@ state. When you run
-- RestoreServer, the server\'s EC2 instance is deleted, and a new EC2
-- instance is configured. RestoreServer maintains the existing server
-- endpoint, so configuration management of the server\'s client devices
-- (nodes) should continue to work.
--
-- Restoring from a backup is performed by creating a new EC2 instance. If
-- restoration is successful, and the server is in a @HEALTHY@ state, AWS
-- OpsWorks CM switches traffic over to the new instance. After restoration
-- is finished, the old EC2 instance is maintained in a @Running@ or
-- @Stopped@ state, but is eventually terminated.
--
-- This operation is asynchronous.
--
-- An @InvalidStateException@ is thrown when the server is not in a valid
-- state. A @ResourceNotFoundException@ is thrown when the server does not
-- exist. A @ValidationException@ is raised when parameters of the request
-- are not valid.
module Amazonka.OpsWorksCM.RestoreServer
  ( -- * Creating a Request
    RestoreServer (..),
    newRestoreServer,

    -- * Request Lenses
    restoreServer_instanceType,
    restoreServer_keyPair,
    restoreServer_backupId,
    restoreServer_serverName,

    -- * Destructuring the Response
    RestoreServerResponse (..),
    newRestoreServerResponse,

    -- * Response Lenses
    restoreServerResponse_server,
    restoreServerResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.OpsWorksCM.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newRestoreServer' smart constructor.
data RestoreServer = RestoreServer'
  { -- | The type of instance to restore. Valid values must be specified in the
    -- following format: @^([cm][34]|t2).*@ For example, @m5.large@. Valid
    -- values are @m5.large@, @r5.xlarge@, and @r5.2xlarge@. If you do not
    -- specify this parameter, RestoreServer uses the instance type from the
    -- specified backup.
    RestoreServer -> Maybe Text
instanceType :: Prelude.Maybe Prelude.Text,
    -- | The name of the key pair to set on the new EC2 instance. This can be
    -- helpful if the administrator no longer has the SSH key.
    RestoreServer -> Maybe Text
keyPair :: Prelude.Maybe Prelude.Text,
    -- | The ID of the backup that you want to use to restore a server.
    RestoreServer -> Text
backupId :: Prelude.Text,
    -- | The name of the server that you want to restore.
    RestoreServer -> Text
serverName :: Prelude.Text
  }
  deriving (RestoreServer -> RestoreServer -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RestoreServer -> RestoreServer -> Bool
$c/= :: RestoreServer -> RestoreServer -> Bool
== :: RestoreServer -> RestoreServer -> Bool
$c== :: RestoreServer -> RestoreServer -> Bool
Prelude.Eq, ReadPrec [RestoreServer]
ReadPrec RestoreServer
Int -> ReadS RestoreServer
ReadS [RestoreServer]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [RestoreServer]
$creadListPrec :: ReadPrec [RestoreServer]
readPrec :: ReadPrec RestoreServer
$creadPrec :: ReadPrec RestoreServer
readList :: ReadS [RestoreServer]
$creadList :: ReadS [RestoreServer]
readsPrec :: Int -> ReadS RestoreServer
$creadsPrec :: Int -> ReadS RestoreServer
Prelude.Read, Int -> RestoreServer -> ShowS
[RestoreServer] -> ShowS
RestoreServer -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RestoreServer] -> ShowS
$cshowList :: [RestoreServer] -> ShowS
show :: RestoreServer -> String
$cshow :: RestoreServer -> String
showsPrec :: Int -> RestoreServer -> ShowS
$cshowsPrec :: Int -> RestoreServer -> ShowS
Prelude.Show, forall x. Rep RestoreServer x -> RestoreServer
forall x. RestoreServer -> Rep RestoreServer x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RestoreServer x -> RestoreServer
$cfrom :: forall x. RestoreServer -> Rep RestoreServer x
Prelude.Generic)

-- |
-- Create a value of 'RestoreServer' 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:
--
-- 'instanceType', 'restoreServer_instanceType' - The type of instance to restore. Valid values must be specified in the
-- following format: @^([cm][34]|t2).*@ For example, @m5.large@. Valid
-- values are @m5.large@, @r5.xlarge@, and @r5.2xlarge@. If you do not
-- specify this parameter, RestoreServer uses the instance type from the
-- specified backup.
--
-- 'keyPair', 'restoreServer_keyPair' - The name of the key pair to set on the new EC2 instance. This can be
-- helpful if the administrator no longer has the SSH key.
--
-- 'backupId', 'restoreServer_backupId' - The ID of the backup that you want to use to restore a server.
--
-- 'serverName', 'restoreServer_serverName' - The name of the server that you want to restore.
newRestoreServer ::
  -- | 'backupId'
  Prelude.Text ->
  -- | 'serverName'
  Prelude.Text ->
  RestoreServer
newRestoreServer :: Text -> Text -> RestoreServer
newRestoreServer Text
pBackupId_ Text
pServerName_ =
  RestoreServer'
    { $sel:instanceType:RestoreServer' :: Maybe Text
instanceType = forall a. Maybe a
Prelude.Nothing,
      $sel:keyPair:RestoreServer' :: Maybe Text
keyPair = forall a. Maybe a
Prelude.Nothing,
      $sel:backupId:RestoreServer' :: Text
backupId = Text
pBackupId_,
      $sel:serverName:RestoreServer' :: Text
serverName = Text
pServerName_
    }

-- | The type of instance to restore. Valid values must be specified in the
-- following format: @^([cm][34]|t2).*@ For example, @m5.large@. Valid
-- values are @m5.large@, @r5.xlarge@, and @r5.2xlarge@. If you do not
-- specify this parameter, RestoreServer uses the instance type from the
-- specified backup.
restoreServer_instanceType :: Lens.Lens' RestoreServer (Prelude.Maybe Prelude.Text)
restoreServer_instanceType :: Lens' RestoreServer (Maybe Text)
restoreServer_instanceType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RestoreServer' {Maybe Text
instanceType :: Maybe Text
$sel:instanceType:RestoreServer' :: RestoreServer -> Maybe Text
instanceType} -> Maybe Text
instanceType) (\s :: RestoreServer
s@RestoreServer' {} Maybe Text
a -> RestoreServer
s {$sel:instanceType:RestoreServer' :: Maybe Text
instanceType = Maybe Text
a} :: RestoreServer)

-- | The name of the key pair to set on the new EC2 instance. This can be
-- helpful if the administrator no longer has the SSH key.
restoreServer_keyPair :: Lens.Lens' RestoreServer (Prelude.Maybe Prelude.Text)
restoreServer_keyPair :: Lens' RestoreServer (Maybe Text)
restoreServer_keyPair = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RestoreServer' {Maybe Text
keyPair :: Maybe Text
$sel:keyPair:RestoreServer' :: RestoreServer -> Maybe Text
keyPair} -> Maybe Text
keyPair) (\s :: RestoreServer
s@RestoreServer' {} Maybe Text
a -> RestoreServer
s {$sel:keyPair:RestoreServer' :: Maybe Text
keyPair = Maybe Text
a} :: RestoreServer)

-- | The ID of the backup that you want to use to restore a server.
restoreServer_backupId :: Lens.Lens' RestoreServer Prelude.Text
restoreServer_backupId :: Lens' RestoreServer Text
restoreServer_backupId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RestoreServer' {Text
backupId :: Text
$sel:backupId:RestoreServer' :: RestoreServer -> Text
backupId} -> Text
backupId) (\s :: RestoreServer
s@RestoreServer' {} Text
a -> RestoreServer
s {$sel:backupId:RestoreServer' :: Text
backupId = Text
a} :: RestoreServer)

-- | The name of the server that you want to restore.
restoreServer_serverName :: Lens.Lens' RestoreServer Prelude.Text
restoreServer_serverName :: Lens' RestoreServer Text
restoreServer_serverName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RestoreServer' {Text
serverName :: Text
$sel:serverName:RestoreServer' :: RestoreServer -> Text
serverName} -> Text
serverName) (\s :: RestoreServer
s@RestoreServer' {} Text
a -> RestoreServer
s {$sel:serverName:RestoreServer' :: Text
serverName = Text
a} :: RestoreServer)

instance Core.AWSRequest RestoreServer where
  type
    AWSResponse RestoreServer =
      RestoreServerResponse
  request :: (Service -> Service) -> RestoreServer -> Request RestoreServer
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy RestoreServer
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse RestoreServer)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Server -> Int -> RestoreServerResponse
RestoreServerResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"Server")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable RestoreServer where
  hashWithSalt :: Int -> RestoreServer -> Int
hashWithSalt Int
_salt RestoreServer' {Maybe Text
Text
serverName :: Text
backupId :: Text
keyPair :: Maybe Text
instanceType :: Maybe Text
$sel:serverName:RestoreServer' :: RestoreServer -> Text
$sel:backupId:RestoreServer' :: RestoreServer -> Text
$sel:keyPair:RestoreServer' :: RestoreServer -> Maybe Text
$sel:instanceType:RestoreServer' :: RestoreServer -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
instanceType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
keyPair
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
backupId
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
serverName

instance Prelude.NFData RestoreServer where
  rnf :: RestoreServer -> ()
rnf RestoreServer' {Maybe Text
Text
serverName :: Text
backupId :: Text
keyPair :: Maybe Text
instanceType :: Maybe Text
$sel:serverName:RestoreServer' :: RestoreServer -> Text
$sel:backupId:RestoreServer' :: RestoreServer -> Text
$sel:keyPair:RestoreServer' :: RestoreServer -> Maybe Text
$sel:instanceType:RestoreServer' :: RestoreServer -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
instanceType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
keyPair
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
backupId
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
serverName

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

instance Data.ToJSON RestoreServer where
  toJSON :: RestoreServer -> Value
toJSON RestoreServer' {Maybe Text
Text
serverName :: Text
backupId :: Text
keyPair :: Maybe Text
instanceType :: Maybe Text
$sel:serverName:RestoreServer' :: RestoreServer -> Text
$sel:backupId:RestoreServer' :: RestoreServer -> Text
$sel:keyPair:RestoreServer' :: RestoreServer -> Maybe Text
$sel:instanceType:RestoreServer' :: RestoreServer -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"InstanceType" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
instanceType,
            (Key
"KeyPair" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
keyPair,
            forall a. a -> Maybe a
Prelude.Just (Key
"BackupId" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
backupId),
            forall a. a -> Maybe a
Prelude.Just (Key
"ServerName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
serverName)
          ]
      )

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

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

-- | /See:/ 'newRestoreServerResponse' smart constructor.
data RestoreServerResponse = RestoreServerResponse'
  { RestoreServerResponse -> Maybe Server
server :: Prelude.Maybe Server,
    -- | The response's http status code.
    RestoreServerResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (RestoreServerResponse -> RestoreServerResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: RestoreServerResponse -> RestoreServerResponse -> Bool
$c/= :: RestoreServerResponse -> RestoreServerResponse -> Bool
== :: RestoreServerResponse -> RestoreServerResponse -> Bool
$c== :: RestoreServerResponse -> RestoreServerResponse -> Bool
Prelude.Eq, Int -> RestoreServerResponse -> ShowS
[RestoreServerResponse] -> ShowS
RestoreServerResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [RestoreServerResponse] -> ShowS
$cshowList :: [RestoreServerResponse] -> ShowS
show :: RestoreServerResponse -> String
$cshow :: RestoreServerResponse -> String
showsPrec :: Int -> RestoreServerResponse -> ShowS
$cshowsPrec :: Int -> RestoreServerResponse -> ShowS
Prelude.Show, forall x. Rep RestoreServerResponse x -> RestoreServerResponse
forall x. RestoreServerResponse -> Rep RestoreServerResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep RestoreServerResponse x -> RestoreServerResponse
$cfrom :: forall x. RestoreServerResponse -> Rep RestoreServerResponse x
Prelude.Generic)

-- |
-- Create a value of 'RestoreServerResponse' 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:
--
-- 'server', 'restoreServerResponse_server' - Undocumented member.
--
-- 'httpStatus', 'restoreServerResponse_httpStatus' - The response's http status code.
newRestoreServerResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  RestoreServerResponse
newRestoreServerResponse :: Int -> RestoreServerResponse
newRestoreServerResponse Int
pHttpStatus_ =
  RestoreServerResponse'
    { $sel:server:RestoreServerResponse' :: Maybe Server
server = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:RestoreServerResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Undocumented member.
restoreServerResponse_server :: Lens.Lens' RestoreServerResponse (Prelude.Maybe Server)
restoreServerResponse_server :: Lens' RestoreServerResponse (Maybe Server)
restoreServerResponse_server = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RestoreServerResponse' {Maybe Server
server :: Maybe Server
$sel:server:RestoreServerResponse' :: RestoreServerResponse -> Maybe Server
server} -> Maybe Server
server) (\s :: RestoreServerResponse
s@RestoreServerResponse' {} Maybe Server
a -> RestoreServerResponse
s {$sel:server:RestoreServerResponse' :: Maybe Server
server = Maybe Server
a} :: RestoreServerResponse)

-- | The response's http status code.
restoreServerResponse_httpStatus :: Lens.Lens' RestoreServerResponse Prelude.Int
restoreServerResponse_httpStatus :: Lens' RestoreServerResponse Int
restoreServerResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\RestoreServerResponse' {Int
httpStatus :: Int
$sel:httpStatus:RestoreServerResponse' :: RestoreServerResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: RestoreServerResponse
s@RestoreServerResponse' {} Int
a -> RestoreServerResponse
s {$sel:httpStatus:RestoreServerResponse' :: Int
httpStatus = Int
a} :: RestoreServerResponse)

instance Prelude.NFData RestoreServerResponse where
  rnf :: RestoreServerResponse -> ()
rnf RestoreServerResponse' {Int
Maybe Server
httpStatus :: Int
server :: Maybe Server
$sel:httpStatus:RestoreServerResponse' :: RestoreServerResponse -> Int
$sel:server:RestoreServerResponse' :: RestoreServerResponse -> Maybe Server
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Server
server
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus