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

Class UserIdentityConfiguration

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

Provides the configuration information for the identifiers of your users.

See Also:

  • Method Details

    • identityAttributeName

      public final String identityAttributeName()

      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.

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

    • toBuilder

      public UserIdentityConfiguration.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<UserIdentityConfiguration.Builder,UserIdentityConfiguration>
      Returns:
      a builder for type T

    • builder

      public static UserIdentityConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UserIdentityConfiguration.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.