Class: Aws::Kendra::Types::UserIdentityConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb

Overview

Note:

When making an API call, you may pass UserIdentityConfiguration data as a hash:

{
  identity_attribute_name: "IdentityAttributeName",
}

Provides the configuration information for the identifiers of your users.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#identity_attribute_nameString

The Amazon Web Services SSO 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 Amazon Web Services SSO 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 Amazon Web Services SSO identity source.

Returns:

  • (String)


13428
13429
13430
13431
13432
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 13428

class UserIdentityConfiguration < Struct.new(
  :identity_attribute_name)
  SENSITIVE = []
  include Aws::Structure
end