software.amazon.awssdk.services.kendra.model

Interface CreateIndexRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, KendraRequest.Builder, SdkBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateIndexRequest

public static interface CreateIndexRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

Method Summary

Modifier and Type	Method and Description
CreateIndexRequest.Builder	clientToken(String clientToken) A token that you provide to identify the request to create an index.
CreateIndexRequest.Builder	description(String description) A description for the index.
CreateIndexRequest.Builder	edition(IndexEdition edition) The Amazon Kendra edition to use for the index.
CreateIndexRequest.Builder	edition(String edition) The Amazon Kendra edition to use for the index.
CreateIndexRequest.Builder	name(String name) A name for the index.
CreateIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateIndexRequest.Builder	roleArn(String roleArn) The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics.
default CreateIndexRequest.Builder	serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration) The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra.
CreateIndexRequest.Builder	serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra.
CreateIndexRequest.Builder	tags(Collection<Tag> tags) A list of key-value pairs that identify or categorize the index.
CreateIndexRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify or categorize the index.
CreateIndexRequest.Builder	tags(Tag... tags) A list of key-value pairs that identify or categorize the index.
CreateIndexRequest.Builder	userContextPolicy(String userContextPolicy) The user context policy.
CreateIndexRequest.Builder	userContextPolicy(UserContextPolicy userContextPolicy) The user context policy.
default CreateIndexRequest.Builder	userGroupResolutionConfiguration(Consumer<UserGroupResolutionConfiguration.Builder> userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source.
CreateIndexRequest.Builder	userGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source.
CreateIndexRequest.Builder	userTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations) The user token configuration.
CreateIndexRequest.Builder	userTokenConfigurations(Consumer<UserTokenConfiguration.Builder>... userTokenConfigurations) The user token configuration.
CreateIndexRequest.Builder	userTokenConfigurations(UserTokenConfiguration... userTokenConfigurations) The user token configuration.

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

CreateIndexRequest.Builder name(String name)

A name for the index.

Parameters:

name - A name for the index.

Returns:

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

edition

CreateIndexRequest.Builder edition(String edition)

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Parameters:

edition - The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Returns:

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

See Also:

IndexEdition, IndexEdition

edition

CreateIndexRequest.Builder edition(IndexEdition edition)

The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Parameters:

edition - The Amazon Kendra edition to use for the index. Choose DEVELOPER_EDITION for indexes intended for development, testing, or proof of concept. Use ENTERPRISE_EDITION for production. Once you set the edition for an index, it can't be changed.

The Edition parameter is optional. If you don't supply a value, the default is ENTERPRISE_EDITION.

For more information on quota limits for Enterprise and Developer editions, see Quotas.

Returns:

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

See Also:

IndexEdition, IndexEdition

roleArn

CreateIndexRequest.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

Parameters:

roleArn - The Amazon Resource Name (ARN) of an IAM role with permission to access your Amazon CloudWatch logs and metrics. For more information, see IAM access roles for Amazon Kendra.

Returns:

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

serverSideEncryptionConfiguration

CreateIndexRequest.Builder serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration)

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Parameters:

serverSideEncryptionConfiguration - The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Returns:

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

serverSideEncryptionConfiguration

default CreateIndexRequest.Builder serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration)

The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

This is a convenience method that creates an instance of the ServerSideEncryptionConfiguration.Builder avoiding the need to create one manually via ServerSideEncryptionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration).

Parameters:

serverSideEncryptionConfiguration - a consumer that will call methods on ServerSideEncryptionConfiguration.Builder

Returns:

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

See Also:

serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)

description

CreateIndexRequest.Builder description(String description)

A description for the index.

Parameters:

description - A description for the index.

Returns:

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

clientToken

CreateIndexRequest.Builder clientToken(String clientToken)

A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Parameters:

clientToken - A token that you provide to identify the request to create an index. Multiple calls to the CreateIndex API with the same client token will create only one index.

Returns:

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

tags

CreateIndexRequest.Builder tags(Collection<Tag> tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

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

tags

CreateIndexRequest.Builder tags(Tag... tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Parameters:

tags - A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Returns:

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

tags

CreateIndexRequest.Builder tags(Consumer<Tag.Builder>... tags)

A list of key-value pairs that identify or categorize the index. You can also use tags to help control access to the index. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

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

See Also:

#tags(java.util.Collection)

userTokenConfigurations

CreateIndexRequest.Builder userTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)

The user token configuration.

Parameters:

userTokenConfigurations - The user token configuration.

Returns:

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

userTokenConfigurations

CreateIndexRequest.Builder userTokenConfigurations(UserTokenConfiguration... userTokenConfigurations)

The user token configuration.

Parameters:

userTokenConfigurations - The user token configuration.

Returns:

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

userTokenConfigurations

CreateIndexRequest.Builder userTokenConfigurations(Consumer<UserTokenConfiguration.Builder>... userTokenConfigurations)

The user token configuration.

This is a convenience method that creates an instance of the UserTokenConfiguration.Builder avoiding the need to create one manually via UserTokenConfiguration.builder() .

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #userTokenConfigurations(List).

Parameters:

userTokenConfigurations - a consumer that will call methods on UserTokenConfiguration.Builder

Returns:

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

See Also:

#userTokenConfigurations(java.util.Collection)

userContextPolicy

CreateIndexRequest.Builder userContextPolicy(String userContextPolicy)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Parameters:

userContextPolicy - The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Returns:

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

See Also:

UserContextPolicy, UserContextPolicy

userContextPolicy

CreateIndexRequest.Builder userContextPolicy(UserContextPolicy userContextPolicy)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Parameters:

userContextPolicy - The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If you want to filter search results on user context, you can use the attribute filters of _user_id and _group_ids or you can provide user and group information in UserContext.

USER_TOKEN

Enables token-based user access control to filter search results on user context. All documents with no access control and all documents accessible to the user will be searchable and displayable.

Returns:

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

See Also:

UserContextPolicy, UserContextPolicy

userGroupResolutionConfiguration

CreateIndexRequest.Builder userGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration)

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

Parameters:

userGroupResolutionConfiguration - Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

Returns:

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

userGroupResolutionConfiguration

default CreateIndexRequest.Builder userGroupResolutionConfiguration(Consumer<UserGroupResolutionConfiguration.Builder> userGroupResolutionConfiguration)

Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration.

This is a convenience method that creates an instance of the UserGroupResolutionConfiguration.Builder avoiding the need to create one manually via UserGroupResolutionConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to userGroupResolutionConfiguration(UserGroupResolutionConfiguration).

Parameters:

userGroupResolutionConfiguration - a consumer that will call methods on UserGroupResolutionConfiguration.Builder

Returns:

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

See Also:

userGroupResolutionConfiguration(UserGroupResolutionConfiguration)

overrideConfiguration

CreateIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder