Struct PutPrincipalMappingInputBuilder 

#[non_exhaustive]
pub struct PutPrincipalMappingInputBuilder { /* private fields */ }

A builder for PutPrincipalMappingInput.

Implementations

impl PutPrincipalMappingInputBuilder

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

The identifier of the index you want to map users to their groups.

This field is required.

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

The identifier of the index you want to map users to their groups.

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

The identifier of the index you want to map users to their groups.

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

The identifier of the data source you want to map users to their groups.

This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

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

The identifier of the data source you want to map users to their groups.

This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

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

The identifier of the data source you want to map users to their groups.

This is useful if a group is tied to multiple data sources, but you only want the group to access documents of a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. However, "Sales and Marketing" team only needs access to customer-related documents stored in Salesforce.

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

The identifier of the group you want to map its users to.

This field is required.

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

The identifier of the group you want to map its users to.

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

The identifier of the group you want to map its users to.

pub fn group_members(self, input: GroupMembers) -> Self

The list that contains your users that belong the same group. This can include sub groups that belong to a group.

For example, the group "Company A" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

This field is required.

pub fn set_group_members(self, input: Option<GroupMembers>) -> Self

The list that contains your users that belong the same group. This can include sub groups that belong to a group.

For example, the group "Company A" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

pub fn get_group_members(&self) -> &Option<GroupMembers>

The list that contains your users that belong the same group. This can include sub groups that belong to a group.

For example, the group "Company A" includes the user "CEO" and the sub groups "Research", "Engineering", and "Sales and Marketing".

If you have more than 1000 users and/or sub groups for a single group, you need to provide the path to the S3 file that lists your users and sub groups for a group. Your sub groups can contain more than 1000 users, but the list of sub groups that belong to a group (and/or users) must be no more than 1000.

pub fn ordering_id(self, input: i64) -> Self

The timestamp identifier you specify to ensure Amazon Kendra doesn't override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed.

The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.

pub fn set_ordering_id(self, input: Option<i64>) -> Self

The timestamp identifier you specify to ensure Amazon Kendra doesn't override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed.

The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.

pub fn get_ordering_id(&self) -> &Option<i64>

The timestamp identifier you specify to ensure Amazon Kendra doesn't override the latest PUT action with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.

The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling PutPrincipalMapping. This ensures your PUT action for that updated group with the latest members list doesn't get overwritten by earlier PUT actions for the same group which are yet to be processed.

The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.

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

The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

For more information, see IAM roles for Amazon Kendra.

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

The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

For more information, see IAM roles for Amazon Kendra.

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

The Amazon Resource Name (ARN) of an IAM role that has access to the S3 file that contains your list of users that belong to a group.

For more information, see IAM roles for Amazon Kendra.

pub fn build(self) -> Result<PutPrincipalMappingInput, BuildError>

Consumes the builder and constructs a PutPrincipalMappingInput.

impl PutPrincipalMappingInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<PutPrincipalMappingOutput, SdkError<PutPrincipalMappingError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for PutPrincipalMappingInputBuilder

fn clone(&self) -> PutPrincipalMappingInputBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PutPrincipalMappingInputBuilder

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

Formats the value using the given formatter.

impl Default for PutPrincipalMappingInputBuilder

fn default() -> PutPrincipalMappingInputBuilder

Returns the “default value” for a type.

impl PartialEq for PutPrincipalMappingInputBuilder

fn eq(&self, other: &PutPrincipalMappingInputBuilder) -> 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 PutPrincipalMappingInputBuilder