Class: Aws::Kendra::Types::UserGroupResolutionConfiguration

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

Overview

Provides the configuration information to get users and groups from an IAM Identity Center identity source. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents. You can also use the

PutPrincipalMapping][1

API to map users to their groups so that you

only need to provide the user ID when you issue the query.

To set up an IAM Identity Center identity source in the console to use with Amazon Kendra, see [Getting started with an IAM Identity Center identity source]. You must also grant the required permissions to use IAM Identity Center with Amazon Kendra. For more information, see [IAM roles for IAM Identity Center].

Amazon Kendra currently does not support using ‘UserGroupResolutionConfiguration` with an Amazon Web Services organization member account for your IAM Identity Center identify source. You must create your index in the management account for the organization in order to use `UserGroupResolutionConfiguration`.

[1]: docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html [2]: docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html [3]: docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#user_group_resolution_mode ⇒ String

The identity store provider (mode) you want to use to get users and groups. IAM Identity Center is currently the only available mode. Your users and groups must exist in an IAM Identity Center identity source in order to use this mode.

Returns:

  • (String) 


11058
11059
11060
11061
11062
 
# File 'lib/aws-sdk-kendra/types.rb', line 11058

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