DescribeRdsDbInstances.hs

{-# LANGUAGE DataKinds                   #-}
{-# LANGUAGE DeriveGeneric               #-}
{-# LANGUAGE FlexibleInstances           #-}
{-# LANGUAGE GeneralizedNewtypeDeriving  #-}
{-# LANGUAGE LambdaCase                  #-}
{-# LANGUAGE NoImplicitPrelude           #-}
{-# LANGUAGE OverloadedStrings           #-}
{-# LANGUAGE RecordWildCards             #-}
{-# LANGUAGE TypeFamilies                #-}

{-# OPTIONS_GHC -fno-warn-unused-imports #-}

-- Module      : Network.AWS.OpsWorks.DescribeRdsDbInstances
-- Copyright   : (c) 2013-2014 Brendan Hay <brendan.g.hay@gmail.com>
-- License     : This Source Code Form is subject to the terms of
--               the Mozilla Public License, v. 2.0.
--               A copy of the MPL can be found in the LICENSE file or
--               you can obtain it at http://mozilla.org/MPL/2.0/.
-- Maintainer  : Brendan Hay <brendan.g.hay@gmail.com>
-- Stability   : experimental
-- Portability : non-portable (GHC extensions)
--
-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- | Describes Amazon RDS instances.
--
-- Required Permissions: To use this action, an IAM user must have a Show,
-- Deploy, or Manage permissions level for the stack, or an attached policy that
-- explicitly grants permissions. For more information on user permissions, see <http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html Managing User Permissions>.
--
-- <http://docs.aws.amazon.com/opsworks/latest/APIReference/API_DescribeRdsDbInstances.html>
module Network.AWS.OpsWorks.DescribeRdsDbInstances
    (
    -- * Request
      DescribeRdsDbInstances
    -- ** Request constructor
    , describeRdsDbInstances
    -- ** Request lenses
    , drdiRdsDbInstanceArns
    , drdiStackId

    -- * Response
    , DescribeRdsDbInstancesResponse
    -- ** Response constructor
    , describeRdsDbInstancesResponse
    -- ** Response lenses
    , drdirRdsDbInstances
    ) where

import Network.AWS.Data (Object)
import Network.AWS.Prelude
import Network.AWS.Request.JSON
import Network.AWS.OpsWorks.Types
import qualified GHC.Exts

data DescribeRdsDbInstances = DescribeRdsDbInstances
    { _drdiRdsDbInstanceArns :: List "RdsDbInstanceArns" Text
    , _drdiStackId           :: Text
    } deriving (Eq, Ord, Read, Show)

-- | 'DescribeRdsDbInstances' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'drdiRdsDbInstanceArns' @::@ ['Text']
--
-- * 'drdiStackId' @::@ 'Text'
--
describeRdsDbInstances :: Text -- ^ 'drdiStackId'
                       -> DescribeRdsDbInstances
describeRdsDbInstances p1 = DescribeRdsDbInstances
    { _drdiStackId           = p1
    , _drdiRdsDbInstanceArns = mempty
    }

-- | An array containing the ARNs of the instances to be described.
drdiRdsDbInstanceArns :: Lens' DescribeRdsDbInstances [Text]
drdiRdsDbInstanceArns =
    lens _drdiRdsDbInstanceArns (\s a -> s { _drdiRdsDbInstanceArns = a })
        . _List

-- | The stack ID that the instances are registered with. The operation returns
-- descriptions of all registered Amazon RDS instances.
drdiStackId :: Lens' DescribeRdsDbInstances Text
drdiStackId = lens _drdiStackId (\s a -> s { _drdiStackId = a })

newtype DescribeRdsDbInstancesResponse = DescribeRdsDbInstancesResponse
    { _drdirRdsDbInstances :: List "RdsDbInstances" RdsDbInstance
    } deriving (Eq, Read, Show, Monoid, Semigroup)

instance GHC.Exts.IsList DescribeRdsDbInstancesResponse where
    type Item DescribeRdsDbInstancesResponse = RdsDbInstance

    fromList = DescribeRdsDbInstancesResponse . GHC.Exts.fromList
    toList   = GHC.Exts.toList . _drdirRdsDbInstances

-- | 'DescribeRdsDbInstancesResponse' constructor.
--
-- The fields accessible through corresponding lenses are:
--
-- * 'drdirRdsDbInstances' @::@ ['RdsDbInstance']
--
describeRdsDbInstancesResponse :: DescribeRdsDbInstancesResponse
describeRdsDbInstancesResponse = DescribeRdsDbInstancesResponse
    { _drdirRdsDbInstances = mempty
    }

-- | An a array of 'RdsDbInstance' objects that describe the instances.
drdirRdsDbInstances :: Lens' DescribeRdsDbInstancesResponse [RdsDbInstance]
drdirRdsDbInstances =
    lens _drdirRdsDbInstances (\s a -> s { _drdirRdsDbInstances = a })
        . _List

instance ToPath DescribeRdsDbInstances where
    toPath = const "/"

instance ToQuery DescribeRdsDbInstances where
    toQuery = const mempty

instance ToHeaders DescribeRdsDbInstances

instance ToJSON DescribeRdsDbInstances where
    toJSON DescribeRdsDbInstances{..} = object
        [ "StackId"           .= _drdiStackId
        , "RdsDbInstanceArns" .= _drdiRdsDbInstanceArns
        ]

instance AWSRequest DescribeRdsDbInstances where
    type Sv DescribeRdsDbInstances = OpsWorks
    type Rs DescribeRdsDbInstances = DescribeRdsDbInstancesResponse

    request  = post "DescribeRdsDbInstances"
    response = jsonResponse

instance FromJSON DescribeRdsDbInstancesResponse where
    parseJSON = withObject "DescribeRdsDbInstancesResponse" $ \o -> DescribeRdsDbInstancesResponse
        <$> o .:? "RdsDbInstances" .!= mempty