RegisterEcsCluster.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.OpsWorks.RegisterEcsCluster
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Registers a specified Amazon ECS cluster with a stack. You can register
-- only one cluster with a stack. A cluster can be registered with only one
-- stack. For more information, see
-- <https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html Resource Management>.
--
-- __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.RegisterEcsCluster
  ( -- * Creating a Request
    RegisterEcsCluster (..),
    newRegisterEcsCluster,

    -- * Request Lenses
    registerEcsCluster_ecsClusterArn,
    registerEcsCluster_stackId,

    -- * Destructuring the Response
    RegisterEcsClusterResponse (..),
    newRegisterEcsClusterResponse,

    -- * Response Lenses
    registerEcsClusterResponse_ecsClusterArn,
    registerEcsClusterResponse_httpStatus,
  )
where

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

-- | /See:/ 'newRegisterEcsCluster' smart constructor.
data RegisterEcsCluster = RegisterEcsCluster'
  { -- | The cluster\'s ARN.
    ecsClusterArn :: Prelude.Text,
    -- | The stack ID.
    stackId :: Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'RegisterEcsCluster' 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:
--
-- 'ecsClusterArn', 'registerEcsCluster_ecsClusterArn' - The cluster\'s ARN.
--
-- 'stackId', 'registerEcsCluster_stackId' - The stack ID.
newRegisterEcsCluster ::
  -- | 'ecsClusterArn'
  Prelude.Text ->
  -- | 'stackId'
  Prelude.Text ->
  RegisterEcsCluster
newRegisterEcsCluster pEcsClusterArn_ pStackId_ =
  RegisterEcsCluster'
    { ecsClusterArn =
        pEcsClusterArn_,
      stackId = pStackId_
    }

-- | The cluster\'s ARN.
registerEcsCluster_ecsClusterArn :: Lens.Lens' RegisterEcsCluster Prelude.Text
registerEcsCluster_ecsClusterArn = Lens.lens (\RegisterEcsCluster' {ecsClusterArn} -> ecsClusterArn) (\s@RegisterEcsCluster' {} a -> s {ecsClusterArn = a} :: RegisterEcsCluster)

-- | The stack ID.
registerEcsCluster_stackId :: Lens.Lens' RegisterEcsCluster Prelude.Text
registerEcsCluster_stackId = Lens.lens (\RegisterEcsCluster' {stackId} -> stackId) (\s@RegisterEcsCluster' {} a -> s {stackId = a} :: RegisterEcsCluster)

instance Core.AWSRequest RegisterEcsCluster where
  type
    AWSResponse RegisterEcsCluster =
      RegisterEcsClusterResponse
  request overrides =
    Request.postJSON (overrides defaultService)
  response =
    Response.receiveJSON
      ( \s h x ->
          RegisterEcsClusterResponse'
            Prelude.<$> (x Data..?> "EcsClusterArn")
            Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
      )

instance Prelude.Hashable RegisterEcsCluster where
  hashWithSalt _salt RegisterEcsCluster' {..} =
    _salt
      `Prelude.hashWithSalt` ecsClusterArn
      `Prelude.hashWithSalt` stackId

instance Prelude.NFData RegisterEcsCluster where
  rnf RegisterEcsCluster' {..} =
    Prelude.rnf ecsClusterArn
      `Prelude.seq` Prelude.rnf stackId

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

instance Data.ToJSON RegisterEcsCluster where
  toJSON RegisterEcsCluster' {..} =
    Data.object
      ( Prelude.catMaybes
          [ Prelude.Just
              ("EcsClusterArn" Data..= ecsClusterArn),
            Prelude.Just ("StackId" Data..= stackId)
          ]
      )

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

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

-- | Contains the response to a @RegisterEcsCluster@ request.
--
-- /See:/ 'newRegisterEcsClusterResponse' smart constructor.
data RegisterEcsClusterResponse = RegisterEcsClusterResponse'
  { -- | The cluster\'s ARN.
    ecsClusterArn :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    httpStatus :: Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'RegisterEcsClusterResponse' 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:
--
-- 'ecsClusterArn', 'registerEcsClusterResponse_ecsClusterArn' - The cluster\'s ARN.
--
-- 'httpStatus', 'registerEcsClusterResponse_httpStatus' - The response's http status code.
newRegisterEcsClusterResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  RegisterEcsClusterResponse
newRegisterEcsClusterResponse pHttpStatus_ =
  RegisterEcsClusterResponse'
    { ecsClusterArn =
        Prelude.Nothing,
      httpStatus = pHttpStatus_
    }

-- | The cluster\'s ARN.
registerEcsClusterResponse_ecsClusterArn :: Lens.Lens' RegisterEcsClusterResponse (Prelude.Maybe Prelude.Text)
registerEcsClusterResponse_ecsClusterArn = Lens.lens (\RegisterEcsClusterResponse' {ecsClusterArn} -> ecsClusterArn) (\s@RegisterEcsClusterResponse' {} a -> s {ecsClusterArn = a} :: RegisterEcsClusterResponse)

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

instance Prelude.NFData RegisterEcsClusterResponse where
  rnf RegisterEcsClusterResponse' {..} =
    Prelude.rnf ecsClusterArn
      `Prelude.seq` Prelude.rnf httpStatus