Interface CreateIndexRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, KendraRequest.Builder, SdkBuilder<CreateIndexRequest.Builder,CreateIndexRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateIndexRequest
@Mutable @NotThreadSafe public static interface CreateIndexRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateIndexRequest.Builder,CreateIndexRequest>

  • Method Details

    • 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. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. 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 Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, 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. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. 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 Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas.

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

    • 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. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. 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 Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, 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. Use GEN_AI_ENTERPRISE_EDITION for creating generative AI applications. 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 Gen AI Enterprise Edition, Enterprise Edition, and Developer Edition indices, see Quotas.

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

    • 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:

    • 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<Tag>).

      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:

    • userTokenConfigurations

      CreateIndexRequest.Builder userTokenConfigurations(Collection<UserTokenConfiguration> userTokenConfigurations)

      The user token configuration.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

      Parameters:
      userTokenConfigurations - The user token configuration.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

      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.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

      Parameters:
      userTokenConfigurations - The user token configuration.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

      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.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use UserTokenConfigurations to configure user context policy, Amazon Kendra returns a ValidationException error.

      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<UserTokenConfiguration>).

      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:

    • userContextPolicy

      CreateIndexRequest.Builder userContextPolicy(String userContextPolicy)

      The user context policy.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

      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.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

      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

      CreateIndexRequest.Builder userContextPolicy(UserContextPolicy userContextPolicy)

      The user context policy.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

      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.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, you can only use ATTRIBUTE_FILTER to filter search results by user context. If you're using an Amazon Kendra Gen AI Enterprise Edition index and you try to use USER_TOKEN to configure user context policy, Amazon Kendra returns a ValidationException error.

      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:

    • 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.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported.

      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.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported.

      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.

      If you're using an Amazon Kendra Gen AI Enterprise Edition index, UserGroupResolutionConfiguration isn't supported.

      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:

    • overrideConfiguration

      CreateIndexRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.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 interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.