Package software.amazon.awssdk.services.kendra.model

Interface CreateThesaurusRequest.Builder

    • Method Detail

      • indexId

        CreateThesaurusRequest.Builder indexId​(String 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

        CreateThesaurusRequest.Builder name​(String 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

        CreateThesaurusRequest.Builder roleArn​(String 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

        CreateThesaurusRequest.Builder tags​(Collection<Tag> 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

        CreateThesaurusRequest.Builder tags​(Tag... 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

        CreateThesaurusRequest.Builder tags​(Consumer<Tag.Builder>... 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).

        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)

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

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