{-# 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.Kendra.Types.HierarchicalPrincipal
-- 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.Kendra.Types.HierarchicalPrincipal where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.Kendra.Types.Principal
import qualified Amazonka.Prelude as Prelude

-- | Information to define the hierarchy for which documents users should
-- have access to.
--
-- /See:/ 'newHierarchicalPrincipal' smart constructor.
data HierarchicalPrincipal = HierarchicalPrincipal'
  { -- | A list of
    -- <https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html principal>
    -- lists that define the hierarchy for which documents users should have
    -- access to. Each hierarchical list specifies which user or group has
    -- allow or deny access for each document.
    HierarchicalPrincipal -> [Principal]
principalList :: [Principal]
  }
  deriving (HierarchicalPrincipal -> HierarchicalPrincipal -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HierarchicalPrincipal -> HierarchicalPrincipal -> Bool
$c/= :: HierarchicalPrincipal -> HierarchicalPrincipal -> Bool
== :: HierarchicalPrincipal -> HierarchicalPrincipal -> Bool
$c== :: HierarchicalPrincipal -> HierarchicalPrincipal -> Bool
Prelude.Eq, ReadPrec [HierarchicalPrincipal]
ReadPrec HierarchicalPrincipal
Int -> ReadS HierarchicalPrincipal
ReadS [HierarchicalPrincipal]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [HierarchicalPrincipal]
$creadListPrec :: ReadPrec [HierarchicalPrincipal]
readPrec :: ReadPrec HierarchicalPrincipal
$creadPrec :: ReadPrec HierarchicalPrincipal
readList :: ReadS [HierarchicalPrincipal]
$creadList :: ReadS [HierarchicalPrincipal]
readsPrec :: Int -> ReadS HierarchicalPrincipal
$creadsPrec :: Int -> ReadS HierarchicalPrincipal
Prelude.Read, Int -> HierarchicalPrincipal -> ShowS
[HierarchicalPrincipal] -> ShowS
HierarchicalPrincipal -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [HierarchicalPrincipal] -> ShowS
$cshowList :: [HierarchicalPrincipal] -> ShowS
show :: HierarchicalPrincipal -> String
$cshow :: HierarchicalPrincipal -> String
showsPrec :: Int -> HierarchicalPrincipal -> ShowS
$cshowsPrec :: Int -> HierarchicalPrincipal -> ShowS
Prelude.Show, forall x. Rep HierarchicalPrincipal x -> HierarchicalPrincipal
forall x. HierarchicalPrincipal -> Rep HierarchicalPrincipal x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep HierarchicalPrincipal x -> HierarchicalPrincipal
$cfrom :: forall x. HierarchicalPrincipal -> Rep HierarchicalPrincipal x
Prelude.Generic)

-- |
-- Create a value of 'HierarchicalPrincipal' 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:
--
-- 'principalList', 'hierarchicalPrincipal_principalList' - A list of
-- <https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html principal>
-- lists that define the hierarchy for which documents users should have
-- access to. Each hierarchical list specifies which user or group has
-- allow or deny access for each document.
newHierarchicalPrincipal ::
  HierarchicalPrincipal
newHierarchicalPrincipal :: HierarchicalPrincipal
newHierarchicalPrincipal =
  HierarchicalPrincipal'
    { $sel:principalList:HierarchicalPrincipal' :: [Principal]
principalList =
        forall a. Monoid a => a
Prelude.mempty
    }

-- | A list of
-- <https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html principal>
-- lists that define the hierarchy for which documents users should have
-- access to. Each hierarchical list specifies which user or group has
-- allow or deny access for each document.
hierarchicalPrincipal_principalList :: Lens.Lens' HierarchicalPrincipal [Principal]
hierarchicalPrincipal_principalList :: Lens' HierarchicalPrincipal [Principal]
hierarchicalPrincipal_principalList = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\HierarchicalPrincipal' {[Principal]
principalList :: [Principal]
$sel:principalList:HierarchicalPrincipal' :: HierarchicalPrincipal -> [Principal]
principalList} -> [Principal]
principalList) (\s :: HierarchicalPrincipal
s@HierarchicalPrincipal' {} [Principal]
a -> HierarchicalPrincipal
s {$sel:principalList:HierarchicalPrincipal' :: [Principal]
principalList = [Principal]
a} :: HierarchicalPrincipal) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON HierarchicalPrincipal where
  parseJSON :: Value -> Parser HierarchicalPrincipal
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"HierarchicalPrincipal"
      ( \Object
x ->
          [Principal] -> HierarchicalPrincipal
HierarchicalPrincipal'
            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
"PrincipalList" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable HierarchicalPrincipal where
  hashWithSalt :: Int -> HierarchicalPrincipal -> Int
hashWithSalt Int
_salt HierarchicalPrincipal' {[Principal]
principalList :: [Principal]
$sel:principalList:HierarchicalPrincipal' :: HierarchicalPrincipal -> [Principal]
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [Principal]
principalList

instance Prelude.NFData HierarchicalPrincipal where
  rnf :: HierarchicalPrincipal -> ()
rnf HierarchicalPrincipal' {[Principal]
principalList :: [Principal]
$sel:principalList:HierarchicalPrincipal' :: HierarchicalPrincipal -> [Principal]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf [Principal]
principalList

instance Data.ToJSON HierarchicalPrincipal where
  toJSON :: HierarchicalPrincipal -> Value
toJSON HierarchicalPrincipal' {[Principal]
principalList :: [Principal]
$sel:principalList:HierarchicalPrincipal' :: HierarchicalPrincipal -> [Principal]
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ forall a. a -> Maybe a
Prelude.Just
              (Key
"PrincipalList" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..= [Principal]
principalList)
          ]
      )