Struct aws_sdk_kendra::operation::create_access_control_configuration::builders::CreateAccessControlConfigurationFluentBuilder

pub struct CreateAccessControlConfigurationFluentBuilder { /* private fields */ }

Fluent builder constructing a request to CreateAccessControlConfiguration.

Creates an access configuration for your documents. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

You can use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.

To apply your access control configuration to certain documents, you call the BatchPutDocument API with the AccessControlConfigurationId included in the Document object. If you use an S3 bucket as a data source, you update the .metadata.json with the AccessControlConfigurationId and synchronize your data source. Amazon Kendra currently only supports access control configuration for S3 data sources and documents indexed using the BatchPutDocument API.

Implementations

impl CreateAccessControlConfigurationFluentBuilder

pub fn as_input(&self) -> &CreateAccessControlConfigurationInputBuilder

Access the CreateAccessControlConfiguration as a reference.

pub async fn send( self, ) -> Result<CreateAccessControlConfigurationOutput, SdkError<CreateAccessControlConfigurationError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self, ) -> CustomizableOperation<CreateAccessControlConfigurationOutput, CreateAccessControlConfigurationError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn index_id(self, input: impl Into<String>) -> Self

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

pub fn set_index_id(self, input: Option<String>) -> Self

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

pub fn get_index_id(&self) -> &Option<String>

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

pub fn name(self, input: impl Into<String>) -> Self

A name for the access control configuration.

pub fn set_name(self, input: Option<String>) -> Self

A name for the access control configuration.

pub fn get_name(&self) -> &Option<String>

A name for the access control configuration.

pub fn description(self, input: impl Into<String>) -> Self

A description for the access control configuration.

pub fn set_description(self, input: Option<String>) -> Self

A description for the access control configuration.

pub fn get_description(&self) -> &Option<String>

A description for the access control configuration.

pub fn access_control_list(self, input: Principal) -> Self

Appends an item to AccessControlList.

To override the contents of this collection use set_access_control_list.

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.

pub fn set_access_control_list(self, input: Option<Vec<Principal>>) -> Self

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.

pub fn get_access_control_list(&self) -> &Option<Vec<Principal>>

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.

pub fn hierarchical_access_control_list( self, input: HierarchicalPrincipal, ) -> Self

Appends an item to HierarchicalAccessControlList.

To override the contents of this collection use set_hierarchical_access_control_list.

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

pub fn set_hierarchical_access_control_list( self, input: Option<Vec<HierarchicalPrincipal>>, ) -> Self

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

pub fn get_hierarchical_access_control_list( &self, ) -> &Option<Vec<HierarchicalPrincipal>>

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

pub fn client_token(self, input: impl Into<String>) -> Self

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.

pub fn set_client_token(self, input: Option<String>) -> Self

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.

pub fn get_client_token(&self) -> &Option<String>

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.

Trait Implementations

impl Clone for CreateAccessControlConfigurationFluentBuilder

fn clone(&self) -> CreateAccessControlConfigurationFluentBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateAccessControlConfigurationFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.