Struct aws_sdk_kendra::types::UserGroupResolutionConfiguration

#[non_exhaustive]
pub struct UserGroupResolutionConfiguration {
    pub user_group_resolution_mode: UserGroupResolutionMode,
}

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

user_group_resolution_mode: UserGroupResolutionMode

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.

Implementations

impl UserGroupResolutionConfiguration

pub fn user_group_resolution_mode(&self) -> &UserGroupResolutionMode

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.

impl UserGroupResolutionConfiguration

pub fn builder() -> UserGroupResolutionConfigurationBuilder

Creates a new builder-style object to manufacture UserGroupResolutionConfiguration.

Trait Implementations

impl Clone for UserGroupResolutionConfiguration

fn clone(&self) -> UserGroupResolutionConfiguration

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UserGroupResolutionConfiguration

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UserGroupResolutionConfiguration

fn eq(&self, other: &UserGroupResolutionConfiguration) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UserGroupResolutionConfiguration