amazonka-rds-2.0: gen/Amazonka/RDS/SwitchoverReadReplica.hs

{-# 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.RDS.SwitchoverReadReplica
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Switches over an Oracle standby database in an Oracle Data Guard
-- environment, making it the new primary database. Issue this command in
-- the Region that hosts the current standby database.
module Amazonka.RDS.SwitchoverReadReplica
  ( -- * Creating a Request
    SwitchoverReadReplica (..),
    newSwitchoverReadReplica,

    -- * Request Lenses
    switchoverReadReplica_dbInstanceIdentifier,

    -- * Destructuring the Response
    SwitchoverReadReplicaResponse (..),
    newSwitchoverReadReplicaResponse,

    -- * Response Lenses
    switchoverReadReplicaResponse_dbInstance,
    switchoverReadReplicaResponse_httpStatus,
  )
where

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 Amazonka.RDS.Types
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newSwitchoverReadReplica' smart constructor.
data SwitchoverReadReplica = SwitchoverReadReplica'
  { -- | The DB instance identifier of the current standby database. This value
    -- is stored as a lowercase string.
    --
    -- Constraints:
    --
    -- -   Must match the identifier of an existing Oracle read replica DB
    --     instance.
    dbInstanceIdentifier :: Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'SwitchoverReadReplica' 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:
--
-- 'dbInstanceIdentifier', 'switchoverReadReplica_dbInstanceIdentifier' - The DB instance identifier of the current standby database. This value
-- is stored as a lowercase string.
--
-- Constraints:
--
-- -   Must match the identifier of an existing Oracle read replica DB
--     instance.
newSwitchoverReadReplica ::
  -- | 'dbInstanceIdentifier'
  Prelude.Text ->
  SwitchoverReadReplica
newSwitchoverReadReplica pDBInstanceIdentifier_ =
  SwitchoverReadReplica'
    { dbInstanceIdentifier =
        pDBInstanceIdentifier_
    }

-- | The DB instance identifier of the current standby database. This value
-- is stored as a lowercase string.
--
-- Constraints:
--
-- -   Must match the identifier of an existing Oracle read replica DB
--     instance.
switchoverReadReplica_dbInstanceIdentifier :: Lens.Lens' SwitchoverReadReplica Prelude.Text
switchoverReadReplica_dbInstanceIdentifier = Lens.lens (\SwitchoverReadReplica' {dbInstanceIdentifier} -> dbInstanceIdentifier) (\s@SwitchoverReadReplica' {} a -> s {dbInstanceIdentifier = a} :: SwitchoverReadReplica)

instance Core.AWSRequest SwitchoverReadReplica where
  type
    AWSResponse SwitchoverReadReplica =
      SwitchoverReadReplicaResponse
  request overrides =
    Request.postQuery (overrides defaultService)
  response =
    Response.receiveXMLWrapper
      "SwitchoverReadReplicaResult"
      ( \s h x ->
          SwitchoverReadReplicaResponse'
            Prelude.<$> (x Data..@? "DBInstance")
            Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
      )

instance Prelude.Hashable SwitchoverReadReplica where
  hashWithSalt _salt SwitchoverReadReplica' {..} =
    _salt `Prelude.hashWithSalt` dbInstanceIdentifier

instance Prelude.NFData SwitchoverReadReplica where
  rnf SwitchoverReadReplica' {..} =
    Prelude.rnf dbInstanceIdentifier

instance Data.ToHeaders SwitchoverReadReplica where
  toHeaders = Prelude.const Prelude.mempty

instance Data.ToPath SwitchoverReadReplica where
  toPath = Prelude.const "/"

instance Data.ToQuery SwitchoverReadReplica where
  toQuery SwitchoverReadReplica' {..} =
    Prelude.mconcat
      [ "Action"
          Data.=: ("SwitchoverReadReplica" :: Prelude.ByteString),
        "Version"
          Data.=: ("2014-10-31" :: Prelude.ByteString),
        "DBInstanceIdentifier" Data.=: dbInstanceIdentifier
      ]

-- | /See:/ 'newSwitchoverReadReplicaResponse' smart constructor.
data SwitchoverReadReplicaResponse = SwitchoverReadReplicaResponse'
  { dbInstance :: Prelude.Maybe DBInstance,
    -- | The response's http status code.
    httpStatus :: Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'SwitchoverReadReplicaResponse' 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:
--
-- 'dbInstance', 'switchoverReadReplicaResponse_dbInstance' - Undocumented member.
--
-- 'httpStatus', 'switchoverReadReplicaResponse_httpStatus' - The response's http status code.
newSwitchoverReadReplicaResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  SwitchoverReadReplicaResponse
newSwitchoverReadReplicaResponse pHttpStatus_ =
  SwitchoverReadReplicaResponse'
    { dbInstance =
        Prelude.Nothing,
      httpStatus = pHttpStatus_
    }

-- | Undocumented member.
switchoverReadReplicaResponse_dbInstance :: Lens.Lens' SwitchoverReadReplicaResponse (Prelude.Maybe DBInstance)
switchoverReadReplicaResponse_dbInstance = Lens.lens (\SwitchoverReadReplicaResponse' {dbInstance} -> dbInstance) (\s@SwitchoverReadReplicaResponse' {} a -> s {dbInstance = a} :: SwitchoverReadReplicaResponse)

-- | The response's http status code.
switchoverReadReplicaResponse_httpStatus :: Lens.Lens' SwitchoverReadReplicaResponse Prelude.Int
switchoverReadReplicaResponse_httpStatus = Lens.lens (\SwitchoverReadReplicaResponse' {httpStatus} -> httpStatus) (\s@SwitchoverReadReplicaResponse' {} a -> s {httpStatus = a} :: SwitchoverReadReplicaResponse)

instance Prelude.NFData SwitchoverReadReplicaResponse where
  rnf SwitchoverReadReplicaResponse' {..} =
    Prelude.rnf dbInstance
      `Prelude.seq` Prelude.rnf httpStatus