Package software.amazon.awssdk.services.kendra.model

Class UserGroupResolutionConfiguration

java.lang.Object
software.amazon.awssdk.services.kendra.model.UserGroupResolutionConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<UserGroupResolutionConfiguration.Builder,UserGroupResolutionConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class UserGroupResolutionConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<UserGroupResolutionConfiguration.Builder,UserGroupResolutionConfiguration>

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.

See Also:

  • Method Details

    • userGroupResolutionMode

      public final UserGroupResolutionMode 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.

      If the service returns an enum value that is not available in the current SDK version, userGroupResolutionMode will return UserGroupResolutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userGroupResolutionModeAsString().

      Returns:
      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.
      See Also:

    • userGroupResolutionModeAsString

      public final String userGroupResolutionModeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, userGroupResolutionMode will return UserGroupResolutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userGroupResolutionModeAsString().

      Returns:
      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.
      See Also:

    • toBuilder

      public UserGroupResolutionConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UserGroupResolutionConfiguration.Builder,UserGroupResolutionConfiguration>
      Returns:
      a builder for type T

    • builder

      public static UserGroupResolutionConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UserGroupResolutionConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.