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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceUserIdentityConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UserIdentityConfiguration.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()StringidentityAttributeName()The IAM Identity Center field name that contains the identifiers of your users, such as their emails.List<SdkField<?>>sdkFields()static Class<? extends UserIdentityConfiguration.Builder>serializableBuilderClass()UserIdentityConfiguration.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<UserIdentityConfiguration.Builder,UserIdentityConfiguration>
-
builder
public static UserIdentityConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends UserIdentityConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-