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

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 UserGroupResolutionConfiguration data as a hash:

{
  user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
}

Provides the configuration information to fetch access levels of groups and users from an AWS Single Sign-On identity source. This is useful for setting up user context filtering, where Amazon Kendra filters search results for different users based on their group's access to documents. You can also map your users to their groups for user context filtering using the PutPrincipalMapping operation.

To set up an AWS SSO identity source in the console to use with Amazon Kendra, see Getting started with an AWS SSO identity source. You must also grant the required permissions to use AWS SSO with Amazon Kendra. For more information, see IAM roles for AWS Single Sign-On.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#user_group_resolution_modeString

The identity store provider (mode) you want to use to fetch access levels of groups and users. AWS Single Sign-On is currently the only available mode. Your users and groups must exist in an AWS SSO identity source in order to use this mode.

Returns:

  • (String)


9150
9151
9152
9153
9154
# File 'gems/aws-sdk-kendra/lib/aws-sdk-kendra/types.rb', line 9150

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