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

Interface CreateAccessControlConfigurationRequest.Builder

    • Method Detail

      • indexId

        CreateAccessControlConfigurationRequest.Builder indexId​(String indexId)

        The identifier of the index to create an access control configuration for your documents.

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

      • name

        CreateAccessControlConfigurationRequest.Builder name​(String name)

        A name for the access control configuration.

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

      • description

        CreateAccessControlConfigurationRequest.Builder description​(String description)

        A description for the access control configuration.

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

      • accessControlList

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

        Information 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 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

        CreateAccessControlConfigurationRequest.Builder accessControlList​(Principal... accessControlList)

        Information 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 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

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

        Information 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

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

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

        Parameters:
        hierarchicalAccessControlList - The 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

        CreateAccessControlConfigurationRequest.Builder hierarchicalAccessControlList​(HierarchicalPrincipal... hierarchicalAccessControlList)

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

        Parameters:
        hierarchicalAccessControlList - The 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.

      • clientToken

        CreateAccessControlConfigurationRequest.Builder clientToken​(String clientToken)

        A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.

        Parameters:
        clientToken - A token that you provide to identify the request to create an access control configuration. Multiple calls to the CreateAccessControlConfiguration API with the same client token will create only one access control configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.