DeleteAccelerator.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.GlobalAccelerator.DeleteAccelerator
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Delete an accelerator. Before you can delete an accelerator, you must
-- disable it and remove all dependent resources (listeners and endpoint
-- groups). To disable the accelerator, update the accelerator to set
-- @Enabled@ to false.
--
-- When you create an accelerator, by default, Global Accelerator provides
-- you with a set of two static IP addresses. Alternatively, you can bring
-- your own IP address ranges to Global Accelerator and assign IP addresses
-- from those ranges.
--
-- The IP addresses are assigned to your accelerator for as long as it
-- exists, even if you disable the accelerator and it no longer accepts or
-- routes traffic. However, when you /delete/ an accelerator, you lose the
-- static IP addresses that are assigned to the accelerator, so you can no
-- longer route traffic by using them. As a best practice, ensure that you
-- have permissions in place to avoid inadvertently deleting accelerators.
-- You can use IAM policies with Global Accelerator to limit the users who
-- have permissions to delete an accelerator. For more information, see
-- <https://docs.aws.amazon.com/global-accelerator/latest/dg/auth-and-access-control.html Identity and access management>
-- in the /Global Accelerator Developer Guide/.
module Amazonka.GlobalAccelerator.DeleteAccelerator
  ( -- * Creating a Request
    DeleteAccelerator (..),
    newDeleteAccelerator,

    -- * Request Lenses
    deleteAccelerator_acceleratorArn,

    -- * Destructuring the Response
    DeleteAcceleratorResponse (..),
    newDeleteAcceleratorResponse,
  )
where

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

-- | /See:/ 'newDeleteAccelerator' smart constructor.
data DeleteAccelerator = DeleteAccelerator'
  { -- | The Amazon Resource Name (ARN) of an accelerator.
    acceleratorArn :: Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'DeleteAccelerator' 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:
--
-- 'acceleratorArn', 'deleteAccelerator_acceleratorArn' - The Amazon Resource Name (ARN) of an accelerator.
newDeleteAccelerator ::
  -- | 'acceleratorArn'
  Prelude.Text ->
  DeleteAccelerator
newDeleteAccelerator pAcceleratorArn_ =
  DeleteAccelerator'
    { acceleratorArn =
        pAcceleratorArn_
    }

-- | The Amazon Resource Name (ARN) of an accelerator.
deleteAccelerator_acceleratorArn :: Lens.Lens' DeleteAccelerator Prelude.Text
deleteAccelerator_acceleratorArn = Lens.lens (\DeleteAccelerator' {acceleratorArn} -> acceleratorArn) (\s@DeleteAccelerator' {} a -> s {acceleratorArn = a} :: DeleteAccelerator)

instance Core.AWSRequest DeleteAccelerator where
  type
    AWSResponse DeleteAccelerator =
      DeleteAcceleratorResponse
  request overrides =
    Request.postJSON (overrides defaultService)
  response =
    Response.receiveNull DeleteAcceleratorResponse'

instance Prelude.Hashable DeleteAccelerator where
  hashWithSalt _salt DeleteAccelerator' {..} =
    _salt `Prelude.hashWithSalt` acceleratorArn

instance Prelude.NFData DeleteAccelerator where
  rnf DeleteAccelerator' {..} =
    Prelude.rnf acceleratorArn

instance Data.ToHeaders DeleteAccelerator where
  toHeaders =
    Prelude.const
      ( Prelude.mconcat
          [ "X-Amz-Target"
              Data.=# ( "GlobalAccelerator_V20180706.DeleteAccelerator" ::
                          Prelude.ByteString
                      ),
            "Content-Type"
              Data.=# ( "application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DeleteAccelerator where
  toJSON DeleteAccelerator' {..} =
    Data.object
      ( Prelude.catMaybes
          [ Prelude.Just
              ("AcceleratorArn" Data..= acceleratorArn)
          ]
      )

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

instance Data.ToQuery DeleteAccelerator where
  toQuery = Prelude.const Prelude.mempty

-- | /See:/ 'newDeleteAcceleratorResponse' smart constructor.
data DeleteAcceleratorResponse = DeleteAcceleratorResponse'
  {
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'DeleteAcceleratorResponse' 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.
newDeleteAcceleratorResponse ::
  DeleteAcceleratorResponse
newDeleteAcceleratorResponse =
  DeleteAcceleratorResponse'

instance Prelude.NFData DeleteAcceleratorResponse where
  rnf _ = ()