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

Interface UpdateIndexRequest.Builder

    • Method Detail

      • id

        UpdateIndexRequest.Builder id​(String id)

        The identifier of the index you want to update.

        Parameters:
        id - The identifier of the index you want to update.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        UpdateIndexRequest.Builder name​(String name)

        A new name for the index.

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

      • roleArn

        UpdateIndexRequest.Builder roleArn​(String roleArn)

        An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.

        Parameters:
        roleArn - An Identity and Access Management (IAM) role that gives Amazon Kendra permission to access Amazon CloudWatch logs and metrics.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        UpdateIndexRequest.Builder description​(String description)

        A new description for the index.

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

      • documentMetadataConfigurationUpdates

        UpdateIndexRequest.Builder documentMetadataConfigurationUpdates​(Collection<DocumentMetadataConfiguration> documentMetadataConfigurationUpdates)

        The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

        Parameters:
        documentMetadataConfigurationUpdates - The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentMetadataConfigurationUpdates

        UpdateIndexRequest.Builder documentMetadataConfigurationUpdates​(DocumentMetadataConfiguration... documentMetadataConfigurationUpdates)

        The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.

        Parameters:
        documentMetadataConfigurationUpdates - The document metadata configuration you want to update for the index. Document metadata are fields or attributes associated with your documents. For example, the company department name associated with each document.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • capacityUnits

        UpdateIndexRequest.Builder capacityUnits​(CapacityUnitsConfiguration capacityUnits)

        Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

        If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

        Parameters:
        capacityUnits - Sets the number of additional document storage and query capacity units that should be used by the index. You can change the capacity of the index up to 5 times per day, or make 5 API calls.

        If you are using extra storage units, you can't reduce the storage capacity below what is required to meet the storage needs for your index.

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

      • userTokenConfigurations

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

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

      • userGroupResolutionConfiguration

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