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

Interface CreateAccessControlConfigurationRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateAccessControlConfigurationRequest.Builder,CreateAccessControlConfigurationRequest>, KendraRequest.Builder, SdkBuilder<CreateAccessControlConfigurationRequest.Builder,CreateAccessControlConfigurationRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateAccessControlConfigurationRequest

public static interface CreateAccessControlConfigurationRequest.Builder
extends KendraRequest.Builder, SdkPojo, CopyableBuilder<CreateAccessControlConfigurationRequest.Builder,CreateAccessControlConfigurationRequest>

Method Summary

Modifier and Type	Method	Description
CreateAccessControlConfigurationRequest.Builder	accessControlList(Collection<Principal> accessControlList)	Information on principals (users and/or groups) and which documents they should have access to.
CreateAccessControlConfigurationRequest.Builder	accessControlList(Consumer<Principal.Builder>... accessControlList)	Information on principals (users and/or groups) and which documents they should have access to.
CreateAccessControlConfigurationRequest.Builder	accessControlList(Principal... accessControlList)	Information on principals (users and/or groups) and which documents they should have access to.
CreateAccessControlConfigurationRequest.Builder	clientToken(String clientToken)	A token that you provide to identify the request to create an access control configuration.
CreateAccessControlConfigurationRequest.Builder	description(String description)	A description for the access control configuration.
CreateAccessControlConfigurationRequest.Builder	hierarchicalAccessControlList(Collection<HierarchicalPrincipal> hierarchicalAccessControlList)	The list of principal lists that define the hierarchy for which documents users should have access to.
CreateAccessControlConfigurationRequest.Builder	hierarchicalAccessControlList(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList)	The list of principal lists that define the hierarchy for which documents users should have access to.
CreateAccessControlConfigurationRequest.Builder	hierarchicalAccessControlList(HierarchicalPrincipal... hierarchicalAccessControlList)	The list of principal lists that define the hierarchy for which documents users should have access to.
CreateAccessControlConfigurationRequest.Builder	indexId(String indexId)	The identifier of the index to create an access control configuration for your documents.
CreateAccessControlConfigurationRequest.Builder	name(String name)	A name for the access control configuration.
CreateAccessControlConfigurationRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateAccessControlConfigurationRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.kendra.model.KendraRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

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<Principal>).

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<Principal>)

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.

hierarchicalAccessControlList

CreateAccessControlConfigurationRequest.Builder hierarchicalAccessControlList(Consumer<HierarchicalPrincipal.Builder>... hierarchicalAccessControlList)

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

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to hierarchicalAccessControlList(List<HierarchicalPrincipal>).

Parameters:

hierarchicalAccessControlList - a consumer that will call methods on HierarchicalPrincipal.Builder

Returns:

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

See Also:

• hierarchicalAccessControlList(java.util.Collection<HierarchicalPrincipal>)

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.

overrideConfiguration

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

CreateAccessControlConfigurationRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

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.