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) The name for the new index.
CreateIndexRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateIndexRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateIndexRequest.Builder	roleArn(String roleArn) An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics.
default CreateIndexRequest.Builder	serverSideEncryptionConfiguration(Consumer<ServerSideEncryptionConfiguration.Builder> serverSideEncryptionConfiguration) The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
CreateIndexRequest.Builder	serverSideEncryptionConfiguration(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The identifier of the AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra.
CreateIndexRequest.Builder	tags(Collection<Tag> tags) A list of key-value pairs that identify the index.
CreateIndexRequest.Builder	tags(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify the index.
CreateIndexRequest.Builder	tags(Tag... tags) A list of key-value pairs that identify the index.
CreateIndexRequest.Builder	userContextPolicy(String userContextPolicy) The user context policy.
CreateIndexRequest.Builder	userContextPolicy(UserContextPolicy userContextPolicy) The user context policy.
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)

The name for the new index.

Parameters:

name - The name for the new 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 your production databases. 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.

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 your production databases. 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.

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 your production databases. 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.

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 your production databases. 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.

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)

An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

Parameters:

roleArn - An AWS Identity and Access Management (IAM) role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument operation to index documents from an Amazon S3 bucket.

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 AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

Parameters:

serverSideEncryptionConfiguration - The identifier of the AWS KMS customer managed key (CMK) to use 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 AWS KMS customer managed key (CMK) to use to encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support asymmetric CMKs.

This is a convenience 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 operation 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 operation 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 the index. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

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 the index. You can use the tags to identify and organize your resources and to control access to resources.

Parameters:

tags - A list of key-value pairs that identify the index. You can use the tags to identify and organize your resources and to control access to resources.

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 the index. You can use the tags to identify and organize your resources and to control access to resources.

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tags(List).

Parameters:

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

Returns:

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

See Also:

#tags(List)

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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #userTokenConfigurations(List).

Parameters:

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

Returns:

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

See Also:

#userTokenConfigurations(List)

userContextPolicy

CreateIndexRequest.Builder userContextPolicy(String userContextPolicy)

The user context policy.

ATTRIBUTE_FILTER

All indexed content is searchable and displayable for all users. If there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. 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 there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. 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 there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. 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 there is an access control list, it is ignored. You can filter on user and group attributes.

USER_TOKEN

Enables SSO and token-based user access control. 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

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