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

Interface UserIdentityConfiguration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UserIdentityConfiguration.Builder,UserIdentityConfiguration>, SdkBuilder<UserIdentityConfiguration.Builder,UserIdentityConfiguration>, SdkPojo

Enclosing class:

UserIdentityConfiguration

public static interface UserIdentityConfiguration.Builder
extends SdkPojo, CopyableBuilder<UserIdentityConfiguration.Builder,UserIdentityConfiguration>

Method Summary

Modifier and Type	Method	Description
UserIdentityConfiguration.Builder	identityAttributeName(String identityAttributeName)	The IAM Identity Center field name that contains the identifiers of your users, such as their emails.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

identityAttributeName

UserIdentityConfiguration.Builder identityAttributeName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.