Struct CreateAccessControlConfigurationInput 

#[non_exhaustive]
pub struct CreateAccessControlConfigurationInput {
    pub index_id: Option<String>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub access_control_list: Option<Vec<Principal>>,
    pub hierarchical_access_control_list: Option<Vec<HierarchicalPrincipal>>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

index_id: Option<String>

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

name: Option<String>

A name for the access control configuration.

description: Option<String>

A description for the access control configuration.

access_control_list: 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.

hierarchical_access_control_list: Option<Vec<HierarchicalPrincipal>>

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

client_token: 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.

Implementations

impl CreateAccessControlConfigurationInput

pub fn index_id(&self) -> Option<&str>

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

pub fn name(&self) -> Option<&str>

A name for the access control configuration.

pub fn description(&self) -> Option<&str>

A description for the access control configuration.

pub fn access_control_list(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .access_control_list.is_none().

pub fn hierarchical_access_control_list(&self) -> &[HierarchicalPrincipal]

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

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .hierarchical_access_control_list.is_none().

pub fn client_token(&self) -> Option<&str>

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.

impl CreateAccessControlConfigurationInput

pub fn builder() -> CreateAccessControlConfigurationInputBuilder

Creates a new builder-style object to manufacture CreateAccessControlConfigurationInput.

Trait Implementations

impl Clone for CreateAccessControlConfigurationInput

fn clone(&self) -> CreateAccessControlConfigurationInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateAccessControlConfigurationInput

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

Formats the value using the given formatter.

impl PartialEq for CreateAccessControlConfigurationInput

fn eq(&self, other: &CreateAccessControlConfigurationInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateAccessControlConfigurationInput