{-# 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.UserIdentityConfiguration
-- 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.UserIdentityConfiguration 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

-- | Provides the configuration information for the identifiers of your
-- users.
--
-- /See:/ 'newUserIdentityConfiguration' smart constructor.
data UserIdentityConfiguration = UserIdentityConfiguration'
  { -- | The IAM Identity Center field name that contains the identifiers of your
    -- users, such as their emails. This is used for
    -- <https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html user context filtering>
    -- and for granting access to your Amazon Kendra experience. You must set
    -- up IAM Identity Center with Amazon Kendra. You must include your users
    -- and groups in your Access Control List when you ingest documents into
    -- your index. For more information, see
    -- <https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html Getting started with an IAM Identity Center identity source>.
    UserIdentityConfiguration -> Maybe Text
identityAttributeName :: Prelude.Maybe Prelude.Text
  }
  deriving (UserIdentityConfiguration -> UserIdentityConfiguration -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool
$c/= :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool
== :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool
$c== :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool
Prelude.Eq, ReadPrec [UserIdentityConfiguration]
ReadPrec UserIdentityConfiguration
Int -> ReadS UserIdentityConfiguration
ReadS [UserIdentityConfiguration]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [UserIdentityConfiguration]
$creadListPrec :: ReadPrec [UserIdentityConfiguration]
readPrec :: ReadPrec UserIdentityConfiguration
$creadPrec :: ReadPrec UserIdentityConfiguration
readList :: ReadS [UserIdentityConfiguration]
$creadList :: ReadS [UserIdentityConfiguration]
readsPrec :: Int -> ReadS UserIdentityConfiguration
$creadsPrec :: Int -> ReadS UserIdentityConfiguration
Prelude.Read, Int -> UserIdentityConfiguration -> ShowS
[UserIdentityConfiguration] -> ShowS
UserIdentityConfiguration -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UserIdentityConfiguration] -> ShowS
$cshowList :: [UserIdentityConfiguration] -> ShowS
show :: UserIdentityConfiguration -> String
$cshow :: UserIdentityConfiguration -> String
showsPrec :: Int -> UserIdentityConfiguration -> ShowS
$cshowsPrec :: Int -> UserIdentityConfiguration -> ShowS
Prelude.Show, forall x.
Rep UserIdentityConfiguration x -> UserIdentityConfiguration
forall x.
UserIdentityConfiguration -> Rep UserIdentityConfiguration x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep UserIdentityConfiguration x -> UserIdentityConfiguration
$cfrom :: forall x.
UserIdentityConfiguration -> Rep UserIdentityConfiguration x
Prelude.Generic)

-- |
-- Create a value of 'UserIdentityConfiguration' 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:
--
-- 'identityAttributeName', 'userIdentityConfiguration_identityAttributeName' - The IAM Identity Center field name that contains the identifiers of your
-- users, such as their emails. This is used for
-- <https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html user context filtering>
-- and for granting access to your Amazon Kendra experience. You must set
-- up IAM Identity Center with Amazon Kendra. You must include your users
-- and groups in your Access Control List when you ingest documents into
-- your index. For more information, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html Getting started with an IAM Identity Center identity source>.
newUserIdentityConfiguration ::
  UserIdentityConfiguration
newUserIdentityConfiguration :: UserIdentityConfiguration
newUserIdentityConfiguration =
  UserIdentityConfiguration'
    { $sel:identityAttributeName:UserIdentityConfiguration' :: Maybe Text
identityAttributeName =
        forall a. Maybe a
Prelude.Nothing
    }

-- | The IAM Identity Center field name that contains the identifiers of your
-- users, such as their emails. This is used for
-- <https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html user context filtering>
-- and for granting access to your Amazon Kendra experience. You must set
-- up IAM Identity Center with Amazon Kendra. You must include your users
-- and groups in your Access Control List when you ingest documents into
-- your index. For more information, see
-- <https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html Getting started with an IAM Identity Center identity source>.
userIdentityConfiguration_identityAttributeName :: Lens.Lens' UserIdentityConfiguration (Prelude.Maybe Prelude.Text)
userIdentityConfiguration_identityAttributeName :: Lens' UserIdentityConfiguration (Maybe Text)
userIdentityConfiguration_identityAttributeName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\UserIdentityConfiguration' {Maybe Text
identityAttributeName :: Maybe Text
$sel:identityAttributeName:UserIdentityConfiguration' :: UserIdentityConfiguration -> Maybe Text
identityAttributeName} -> Maybe Text
identityAttributeName) (\s :: UserIdentityConfiguration
s@UserIdentityConfiguration' {} Maybe Text
a -> UserIdentityConfiguration
s {$sel:identityAttributeName:UserIdentityConfiguration' :: Maybe Text
identityAttributeName = Maybe Text
a} :: UserIdentityConfiguration)

instance Data.FromJSON UserIdentityConfiguration where
  parseJSON :: Value -> Parser UserIdentityConfiguration
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"UserIdentityConfiguration"
      ( \Object
x ->
          Maybe Text -> UserIdentityConfiguration
UserIdentityConfiguration'
            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
"IdentityAttributeName")
      )

instance Prelude.Hashable UserIdentityConfiguration where
  hashWithSalt :: Int -> UserIdentityConfiguration -> Int
hashWithSalt Int
_salt UserIdentityConfiguration' {Maybe Text
identityAttributeName :: Maybe Text
$sel:identityAttributeName:UserIdentityConfiguration' :: UserIdentityConfiguration -> Maybe Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
identityAttributeName

instance Prelude.NFData UserIdentityConfiguration where
  rnf :: UserIdentityConfiguration -> ()
rnf UserIdentityConfiguration' {Maybe Text
identityAttributeName :: Maybe Text
$sel:identityAttributeName:UserIdentityConfiguration' :: UserIdentityConfiguration -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
identityAttributeName

instance Data.ToJSON UserIdentityConfiguration where
  toJSON :: UserIdentityConfiguration -> Value
toJSON UserIdentityConfiguration' {Maybe Text
identityAttributeName :: Maybe Text
$sel:identityAttributeName:UserIdentityConfiguration' :: UserIdentityConfiguration -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"IdentityAttributeName" 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
identityAttributeName
          ]
      )