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

Interface UpdateAccessControlConfigurationRequest.Builder

    • Method Detail

      • indexId

        UpdateAccessControlConfigurationRequest.Builder indexId​(String indexId)

        The identifier of the index for an access control configuration.

        Parameters:
        indexId - The identifier of the index for an access control configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • id

        UpdateAccessControlConfigurationRequest.Builder id​(String id)

        The identifier of the access control configuration you want to update.

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

      • name

        UpdateAccessControlConfigurationRequest.Builder name​(String name)

        A new name for the access control configuration.

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

      • description

        UpdateAccessControlConfigurationRequest.Builder description​(String description)

        A new description for the access control configuration.

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

      • accessControlList

        UpdateAccessControlConfigurationRequest.Builder accessControlList​(Collection<Principal> accessControlList)

        Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

        Parameters:
        accessControlList - Information you want to update on principals (users and/or groups) and which documents they should have access to. 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.

      • accessControlList

        UpdateAccessControlConfigurationRequest.Builder accessControlList​(Principal... accessControlList)

        Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

        Parameters:
        accessControlList - Information you want to update on principals (users and/or groups) and which documents they should have access to. 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.

      • accessControlList

        UpdateAccessControlConfigurationRequest.Builder accessControlList​(Consumer<Principal.Builder>... accessControlList)

        Information you want to update on principals (users and/or groups) and which documents they should have access to. 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 the Principal.Builder avoiding the need to create one manually via Principal.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #accessControlList(List).

        Parameters:
        accessControlList - a consumer that will call methods on Principal.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #accessControlList(java.util.Collection)

      • hierarchicalAccessControlList

        UpdateAccessControlConfigurationRequest.Builder hierarchicalAccessControlList​(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)

        The updated list of principal lists that define the hierarchy for which documents users should have access to.

        Parameters:
        hierarchicalAccessControlList - The updated list of principal lists that define the hierarchy for which documents users should have access to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • hierarchicalAccessControlList

        UpdateAccessControlConfigurationRequest.Builder hierarchicalAccessControlList​(HierarchicalPrincipal... hierarchicalAccessControlList)

        The updated list of principal lists that define the hierarchy for which documents users should have access to.

        Parameters:
        hierarchicalAccessControlList - The updated list of principal lists that define the hierarchy for which documents users should have access to.
        Returns:
        Returns a reference to this object so that method calls can be chained together.