{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.Backup.Types.ReportSetting
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.Backup.Types.ReportSetting 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

-- | Contains detailed information about a report setting.
--
-- /See:/ 'newReportSetting' smart constructor.
data ReportSetting = ReportSetting'
  { -- | These are the accounts to be included in the report.
    ReportSetting -> Maybe [Text]
accounts :: Prelude.Maybe [Prelude.Text],
    -- | The Amazon Resource Names (ARNs) of the frameworks a report covers.
    ReportSetting -> Maybe [Text]
frameworkArns :: Prelude.Maybe [Prelude.Text],
    -- | The number of frameworks a report covers.
    ReportSetting -> Maybe Int
numberOfFrameworks :: Prelude.Maybe Prelude.Int,
    -- | These are the Organizational Units to be included in the report.
    ReportSetting -> Maybe [Text]
organizationUnits :: Prelude.Maybe [Prelude.Text],
    -- | These are the Regions to be included in the report.
    ReportSetting -> Maybe [Text]
regions :: Prelude.Maybe [Prelude.Text],
    -- | Identifies the report template for the report. Reports are built using a
    -- report template. The report templates are:
    --
    -- @RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT@
    ReportSetting -> Text
reportTemplate :: Prelude.Text
  }
  deriving (ReportSetting -> ReportSetting -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ReportSetting -> ReportSetting -> Bool
$c/= :: ReportSetting -> ReportSetting -> Bool
== :: ReportSetting -> ReportSetting -> Bool
$c== :: ReportSetting -> ReportSetting -> Bool
Prelude.Eq, ReadPrec [ReportSetting]
ReadPrec ReportSetting
Int -> ReadS ReportSetting
ReadS [ReportSetting]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ReportSetting]
$creadListPrec :: ReadPrec [ReportSetting]
readPrec :: ReadPrec ReportSetting
$creadPrec :: ReadPrec ReportSetting
readList :: ReadS [ReportSetting]
$creadList :: ReadS [ReportSetting]
readsPrec :: Int -> ReadS ReportSetting
$creadsPrec :: Int -> ReadS ReportSetting
Prelude.Read, Int -> ReportSetting -> ShowS
[ReportSetting] -> ShowS
ReportSetting -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ReportSetting] -> ShowS
$cshowList :: [ReportSetting] -> ShowS
show :: ReportSetting -> String
$cshow :: ReportSetting -> String
showsPrec :: Int -> ReportSetting -> ShowS
$cshowsPrec :: Int -> ReportSetting -> ShowS
Prelude.Show, forall x. Rep ReportSetting x -> ReportSetting
forall x. ReportSetting -> Rep ReportSetting x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ReportSetting x -> ReportSetting
$cfrom :: forall x. ReportSetting -> Rep ReportSetting x
Prelude.Generic)

-- |
-- Create a value of 'ReportSetting' 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:
--
-- 'accounts', 'reportSetting_accounts' - These are the accounts to be included in the report.
--
-- 'frameworkArns', 'reportSetting_frameworkArns' - The Amazon Resource Names (ARNs) of the frameworks a report covers.
--
-- 'numberOfFrameworks', 'reportSetting_numberOfFrameworks' - The number of frameworks a report covers.
--
-- 'organizationUnits', 'reportSetting_organizationUnits' - These are the Organizational Units to be included in the report.
--
-- 'regions', 'reportSetting_regions' - These are the Regions to be included in the report.
--
-- 'reportTemplate', 'reportSetting_reportTemplate' - Identifies the report template for the report. Reports are built using a
-- report template. The report templates are:
--
-- @RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT@
newReportSetting ::
  -- | 'reportTemplate'
  Prelude.Text ->
  ReportSetting
newReportSetting :: Text -> ReportSetting
newReportSetting Text
pReportTemplate_ =
  ReportSetting'
    { $sel:accounts:ReportSetting' :: Maybe [Text]
accounts = forall a. Maybe a
Prelude.Nothing,
      $sel:frameworkArns:ReportSetting' :: Maybe [Text]
frameworkArns = forall a. Maybe a
Prelude.Nothing,
      $sel:numberOfFrameworks:ReportSetting' :: Maybe Int
numberOfFrameworks = forall a. Maybe a
Prelude.Nothing,
      $sel:organizationUnits:ReportSetting' :: Maybe [Text]
organizationUnits = forall a. Maybe a
Prelude.Nothing,
      $sel:regions:ReportSetting' :: Maybe [Text]
regions = forall a. Maybe a
Prelude.Nothing,
      $sel:reportTemplate:ReportSetting' :: Text
reportTemplate = Text
pReportTemplate_
    }

-- | These are the accounts to be included in the report.
reportSetting_accounts :: Lens.Lens' ReportSetting (Prelude.Maybe [Prelude.Text])
reportSetting_accounts :: Lens' ReportSetting (Maybe [Text])
reportSetting_accounts = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReportSetting' {Maybe [Text]
accounts :: Maybe [Text]
$sel:accounts:ReportSetting' :: ReportSetting -> Maybe [Text]
accounts} -> Maybe [Text]
accounts) (\s :: ReportSetting
s@ReportSetting' {} Maybe [Text]
a -> ReportSetting
s {$sel:accounts:ReportSetting' :: Maybe [Text]
accounts = Maybe [Text]
a} :: ReportSetting) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The Amazon Resource Names (ARNs) of the frameworks a report covers.
reportSetting_frameworkArns :: Lens.Lens' ReportSetting (Prelude.Maybe [Prelude.Text])
reportSetting_frameworkArns :: Lens' ReportSetting (Maybe [Text])
reportSetting_frameworkArns = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReportSetting' {Maybe [Text]
frameworkArns :: Maybe [Text]
$sel:frameworkArns:ReportSetting' :: ReportSetting -> Maybe [Text]
frameworkArns} -> Maybe [Text]
frameworkArns) (\s :: ReportSetting
s@ReportSetting' {} Maybe [Text]
a -> ReportSetting
s {$sel:frameworkArns:ReportSetting' :: Maybe [Text]
frameworkArns = Maybe [Text]
a} :: ReportSetting) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The number of frameworks a report covers.
reportSetting_numberOfFrameworks :: Lens.Lens' ReportSetting (Prelude.Maybe Prelude.Int)
reportSetting_numberOfFrameworks :: Lens' ReportSetting (Maybe Int)
reportSetting_numberOfFrameworks = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReportSetting' {Maybe Int
numberOfFrameworks :: Maybe Int
$sel:numberOfFrameworks:ReportSetting' :: ReportSetting -> Maybe Int
numberOfFrameworks} -> Maybe Int
numberOfFrameworks) (\s :: ReportSetting
s@ReportSetting' {} Maybe Int
a -> ReportSetting
s {$sel:numberOfFrameworks:ReportSetting' :: Maybe Int
numberOfFrameworks = Maybe Int
a} :: ReportSetting)

-- | These are the Organizational Units to be included in the report.
reportSetting_organizationUnits :: Lens.Lens' ReportSetting (Prelude.Maybe [Prelude.Text])
reportSetting_organizationUnits :: Lens' ReportSetting (Maybe [Text])
reportSetting_organizationUnits = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReportSetting' {Maybe [Text]
organizationUnits :: Maybe [Text]
$sel:organizationUnits:ReportSetting' :: ReportSetting -> Maybe [Text]
organizationUnits} -> Maybe [Text]
organizationUnits) (\s :: ReportSetting
s@ReportSetting' {} Maybe [Text]
a -> ReportSetting
s {$sel:organizationUnits:ReportSetting' :: Maybe [Text]
organizationUnits = Maybe [Text]
a} :: ReportSetting) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | These are the Regions to be included in the report.
reportSetting_regions :: Lens.Lens' ReportSetting (Prelude.Maybe [Prelude.Text])
reportSetting_regions :: Lens' ReportSetting (Maybe [Text])
reportSetting_regions = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReportSetting' {Maybe [Text]
regions :: Maybe [Text]
$sel:regions:ReportSetting' :: ReportSetting -> Maybe [Text]
regions} -> Maybe [Text]
regions) (\s :: ReportSetting
s@ReportSetting' {} Maybe [Text]
a -> ReportSetting
s {$sel:regions:ReportSetting' :: Maybe [Text]
regions = Maybe [Text]
a} :: ReportSetting) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Identifies the report template for the report. Reports are built using a
-- report template. The report templates are:
--
-- @RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT@
reportSetting_reportTemplate :: Lens.Lens' ReportSetting Prelude.Text
reportSetting_reportTemplate :: Lens' ReportSetting Text
reportSetting_reportTemplate = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ReportSetting' {Text
reportTemplate :: Text
$sel:reportTemplate:ReportSetting' :: ReportSetting -> Text
reportTemplate} -> Text
reportTemplate) (\s :: ReportSetting
s@ReportSetting' {} Text
a -> ReportSetting
s {$sel:reportTemplate:ReportSetting' :: Text
reportTemplate = Text
a} :: ReportSetting)

instance Data.FromJSON ReportSetting where
  parseJSON :: Value -> Parser ReportSetting
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"ReportSetting"
      ( \Object
x ->
          Maybe [Text]
-> Maybe [Text]
-> Maybe Int
-> Maybe [Text]
-> Maybe [Text]
-> Text
-> ReportSetting
ReportSetting'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Accounts" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"FrameworkArns" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"NumberOfFrameworks")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"OrganizationUnits"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"Regions" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"ReportTemplate")
      )

instance Prelude.Hashable ReportSetting where
  hashWithSalt :: Int -> ReportSetting -> Int
hashWithSalt Int
_salt ReportSetting' {Maybe Int
Maybe [Text]
Text
reportTemplate :: Text
regions :: Maybe [Text]
organizationUnits :: Maybe [Text]
numberOfFrameworks :: Maybe Int
frameworkArns :: Maybe [Text]
accounts :: Maybe [Text]
$sel:reportTemplate:ReportSetting' :: ReportSetting -> Text
$sel:regions:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:organizationUnits:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:numberOfFrameworks:ReportSetting' :: ReportSetting -> Maybe Int
$sel:frameworkArns:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:accounts:ReportSetting' :: ReportSetting -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
accounts
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
frameworkArns
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
numberOfFrameworks
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
organizationUnits
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
regions
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
reportTemplate

instance Prelude.NFData ReportSetting where
  rnf :: ReportSetting -> ()
rnf ReportSetting' {Maybe Int
Maybe [Text]
Text
reportTemplate :: Text
regions :: Maybe [Text]
organizationUnits :: Maybe [Text]
numberOfFrameworks :: Maybe Int
frameworkArns :: Maybe [Text]
accounts :: Maybe [Text]
$sel:reportTemplate:ReportSetting' :: ReportSetting -> Text
$sel:regions:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:organizationUnits:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:numberOfFrameworks:ReportSetting' :: ReportSetting -> Maybe Int
$sel:frameworkArns:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:accounts:ReportSetting' :: ReportSetting -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
accounts
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
frameworkArns
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
numberOfFrameworks
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
organizationUnits
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
regions
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
reportTemplate

instance Data.ToJSON ReportSetting where
  toJSON :: ReportSetting -> Value
toJSON ReportSetting' {Maybe Int
Maybe [Text]
Text
reportTemplate :: Text
regions :: Maybe [Text]
organizationUnits :: Maybe [Text]
numberOfFrameworks :: Maybe Int
frameworkArns :: Maybe [Text]
accounts :: Maybe [Text]
$sel:reportTemplate:ReportSetting' :: ReportSetting -> Text
$sel:regions:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:organizationUnits:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:numberOfFrameworks:ReportSetting' :: ReportSetting -> Maybe Int
$sel:frameworkArns:ReportSetting' :: ReportSetting -> Maybe [Text]
$sel:accounts:ReportSetting' :: ReportSetting -> Maybe [Text]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"Accounts" 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]
accounts,
            (Key
"FrameworkArns" 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]
frameworkArns,
            (Key
"NumberOfFrameworks" 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 Int
numberOfFrameworks,
            (Key
"OrganizationUnits" 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]
organizationUnits,
            (Key
"Regions" 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]
regions,
            forall a. a -> Maybe a
Prelude.Just
              (Key
"ReportTemplate" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= Text
reportTemplate)
          ]
      )