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

Inherits:

Struct

• Object
• Struct
• Aws::Kendra::Types::UserIdentityConfiguration

Includes:

Structure

Defined in:

lib/aws-sdk-kendra/types.rb

Overview

Provides the configuration information for the identifiers of your users.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #identity_attribute_name ⇒ String

  The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

Instance Attribute Details

#identity_attribute_name ⇒ String

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].

[1]: docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html [2]: docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html

Returns:

• (String)

# File 'lib/aws-sdk-kendra/types.rb', line 11183

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