Interface CreateIndexRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateIndexRequest.Builder,
,CreateIndexRequest> KendraRequest.Builder
,SdkBuilder<CreateIndexRequest.Builder,
,CreateIndexRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateIndexRequest
-
Method Summary
Modifier and TypeMethodDescriptionclientToken
(String clientToken) A token that you provide to identify the request to create an index.description
(String description) A description for the index.The Amazon Kendra edition to use for the index.edition
(IndexEdition edition) The Amazon Kendra edition to use for the index.A name for the index.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.serverSideEncryptionConfiguration
(ServerSideEncryptionConfiguration serverSideEncryptionConfiguration) The identifier of the KMS customer managed key (CMK) that's used to encrypt data indexed by Amazon Kendra.tags
(Collection<Tag> tags) A list of key-value pairs that identify or categorize the index.tags
(Consumer<Tag.Builder>... tags) A list of key-value pairs that identify or categorize the index.A list of key-value pairs that identify or categorize the index.userContextPolicy
(String userContextPolicy) The user context policy.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.userGroupResolutionConfiguration
(UserGroupResolutionConfiguration userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source.userTokenConfigurations
(Collection<UserTokenConfiguration> userTokenConfigurations) The user token configuration.userTokenConfigurations
(Consumer<UserTokenConfiguration.Builder>... userTokenConfigurations) The user token configuration.userTokenConfigurations
(UserTokenConfiguration... userTokenConfigurations) The user token configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder
build
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
-
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
The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITION
for indexes intended for development, testing, or proof of concept. UseENTERPRISE_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 isENTERPRISE_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. ChooseDEVELOPER_EDITION
for indexes intended for development, testing, or proof of concept. UseENTERPRISE_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 isENTERPRISE_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:
-
edition
The Amazon Kendra edition to use for the index. Choose
DEVELOPER_EDITION
for indexes intended for development, testing, or proof of concept. UseENTERPRISE_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 isENTERPRISE_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. ChooseDEVELOPER_EDITION
for indexes intended for development, testing, or proof of concept. UseENTERPRISE_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 isENTERPRISE_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:
-
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 theServerSideEncryptionConfiguration.Builder
avoiding the need to create one manually viaServerSideEncryptionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toserverSideEncryptionConfiguration(ServerSideEncryptionConfiguration)
.- Parameters:
serverSideEncryptionConfiguration
- a consumer that will call methods onServerSideEncryptionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theCreateIndex
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
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
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
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 theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theUserTokenConfiguration.Builder
avoiding the need to create one manually viaUserTokenConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserTokenConfigurations(List<UserTokenConfiguration>)
.- Parameters:
userTokenConfigurations
- a consumer that will call methods onUserTokenConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 inUserContext
. - 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 inUserContext
. - 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
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 inUserContext
. - 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 inUserContext
. - 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:
-
userGroupResolutionConfiguration
CreateIndexRequest.Builder userGroupResolutionConfiguration(UserGroupResolutionConfiguration userGroupResolutionConfiguration) Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
- Parameters:
userGroupResolutionConfiguration
- Gets users and groups from IAM Identity Center identity source. To configure this, see UserGroupResolutionConfiguration. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.- 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 useful for user context filtering, where search results are filtered based on the user or their group access to documents.
This is a convenience method that creates an instance of theUserGroupResolutionConfiguration.Builder
avoiding the need to create one manually viaUserGroupResolutionConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserGroupResolutionConfiguration(UserGroupResolutionConfiguration)
.- Parameters:
userGroupResolutionConfiguration
- a consumer that will call methods onUserGroupResolutionConfiguration.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateIndexRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-