Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.Types.UserIdentityConfiguration

Description

Synopsis

data UserIdentityConfiguration = UserIdentityConfiguration' {
- identityAttributeName :: Maybe Text
}
newUserIdentityConfiguration :: UserIdentityConfiguration
userIdentityConfiguration_identityAttributeName :: Lens' UserIdentityConfiguration (Maybe Text)

Documentation

data UserIdentityConfiguration Source #

Provides the configuration information for the identifiers of your users.

See: newUserIdentityConfiguration smart constructor.

Constructors

UserIdentityConfiguration'

Fields

identityAttributeName :: Maybe Text
The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for 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 Getting started with an IAM Identity Center identity source.

Instances

Instances details

FromJSON UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods parseJSON :: Value -> Parser UserIdentityConfiguration # parseJSONList :: Value -> Parser [UserIdentityConfiguration] #
ToJSON UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods toJSON :: UserIdentityConfiguration -> Value # toEncoding :: UserIdentityConfiguration -> Encoding # toJSONList :: [UserIdentityConfiguration] -> Value # toEncodingList :: [UserIdentityConfiguration] -> Encoding #
Generic UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Associated Types type Rep UserIdentityConfiguration :: Type -> Type # Methods from :: UserIdentityConfiguration -> Rep UserIdentityConfiguration x # to :: Rep UserIdentityConfiguration x -> UserIdentityConfiguration #
Read UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods readsPrec :: Int -> ReadS UserIdentityConfiguration # readList :: ReadS [UserIdentityConfiguration] # readPrec :: ReadPrec UserIdentityConfiguration # readListPrec :: ReadPrec [UserIdentityConfiguration] #
Show UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods showsPrec :: Int -> UserIdentityConfiguration -> ShowS # show :: UserIdentityConfiguration -> String # showList :: [UserIdentityConfiguration] -> ShowS #
NFData UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods rnf :: UserIdentityConfiguration -> () #
Eq UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods (==) :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool # (/=) :: UserIdentityConfiguration -> UserIdentityConfiguration -> Bool #
Hashable UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration Methods hashWithSalt :: Int -> UserIdentityConfiguration -> Int # hash :: UserIdentityConfiguration -> Int #
type Rep UserIdentityConfiguration Source #
Instance details Defined in Amazonka.Kendra.Types.UserIdentityConfiguration type Rep UserIdentityConfiguration = D1 ('MetaData "UserIdentityConfiguration" "Amazonka.Kendra.Types.UserIdentityConfiguration" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UserIdentityConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "identityAttributeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newUserIdentityConfiguration :: UserIdentityConfiguration Source #

Create a value of UserIdentityConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:identityAttributeName:UserIdentityConfiguration', userIdentityConfiguration_identityAttributeName - The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for 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 Getting started with an IAM Identity Center identity source.

userIdentityConfiguration_identityAttributeName :: Lens' UserIdentityConfiguration (Maybe Text) Source #

The IAM Identity Center field name that contains the identifiers of your users, such as their emails. This is used for 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 Getting started with an IAM Identity Center identity source.