Interface CreateThesaurusRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateThesaurusRequest.Builder,CreateThesaurusRequest>, KendraRequest.Builder, SdkBuilder<CreateThesaurusRequest.Builder,CreateThesaurusRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateThesaurusRequest

public static interface CreateThesaurusRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateThesaurusRequest.Builder,CreateThesaurusRequest>
  • Method Details

    • indexId

      The identifier of the index for the thesaurus.

      Parameters:
      indexId - The identifier of the index for the thesaurus.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      A name for the thesaurus.

      Parameters:
      name - A name for the thesaurus.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      CreateThesaurusRequest.Builder description(String description)

      A description for the thesaurus.

      Parameters:
      description - A description for the thesaurus.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • roleArn

      The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket that contains the thesaurus file. 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 S3 bucket that contains the thesaurus file. 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.
    • tags

      A list of key-value pairs that identify or categorize the thesaurus. You can also use tags to help control access to the thesaurus. 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 thesaurus. You can also use tags to help control access to the thesaurus. 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 thesaurus. You can also use tags to help control access to the thesaurus. 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 thesaurus. You can also use tags to help control access to the thesaurus. 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 thesaurus. You can also use tags to help control access to the thesaurus. 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:
    • sourceS3Path

      CreateThesaurusRequest.Builder sourceS3Path(S3Path sourceS3Path)

      The path to the thesaurus file in S3.

      Parameters:
      sourceS3Path - The path to the thesaurus file in S3.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • sourceS3Path

      default CreateThesaurusRequest.Builder sourceS3Path(Consumer<S3Path.Builder> sourceS3Path)

      The path to the thesaurus file in S3.

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

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

      Parameters:
      sourceS3Path - a consumer that will call methods on S3Path.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • clientToken

      CreateThesaurusRequest.Builder clientToken(String clientToken)

      A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus API with the same client token will create only one thesaurus.

      Parameters:
      clientToken - A token that you provide to identify the request to create a thesaurus. Multiple calls to the CreateThesaurus API with the same client token will create only one thesaurus.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

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

      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.