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

Interface PutPrincipalMappingRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<PutPrincipalMappingRequest.Builder,PutPrincipalMappingRequest>, KendraRequest.Builder, SdkBuilder<PutPrincipalMappingRequest.Builder,PutPrincipalMappingRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutPrincipalMappingRequest
public static interface PutPrincipalMappingRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<PutPrincipalMappingRequest.Builder,PutPrincipalMappingRequest>

  • Method Details

    • indexId

      PutPrincipalMappingRequest.Builder indexId(String indexId)

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

      Parameters:
      indexId - The identifier of the index you want to map users to their groups.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceId

      PutPrincipalMappingRequest.Builder dataSourceId(String dataSourceId)

      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.

      Parameters:
      dataSourceId - 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.

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

    • groupId

      PutPrincipalMappingRequest.Builder groupId(String groupId)

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

      Parameters:
      groupId - The identifier of the group you want to map its users to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupMembers

      PutPrincipalMappingRequest.Builder groupMembers(GroupMembers groupMembers)

      The list that contains your users or sub groups that belong the same group.

      For example, the group "Company" 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.

      Parameters:
      groupMembers - The list that contains your users or sub groups that belong the same group.

      For example, the group "Company" 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.

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

    • groupMembers

      default PutPrincipalMappingRequest.Builder groupMembers(Consumer<GroupMembers.Builder> groupMembers)

      The list that contains your users or sub groups that belong the same group.

      For example, the group "Company" 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 is a convenience method that creates an instance of the GroupMembers.Builder avoiding the need to create one manually via GroupMembers.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to groupMembers(GroupMembers).

      Parameters:
      groupMembers - a consumer that will call methods on GroupMembers.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • orderingId

      PutPrincipalMappingRequest.Builder orderingId(Long orderingId)

      The timestamp identifier you specify to ensure Amazon Kendra does not 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.

      Parameters:
      orderingId - The timestamp identifier you specify to ensure Amazon Kendra does not 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.

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

    • roleArn

      PutPrincipalMappingRequest.Builder roleArn(String roleArn)

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

      For more information, see IAM roles for Amazon Kendra.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of a role that has access to the S3 file that contains your list of users or sub groups that belong to a group.

      For more information, see IAM roles for Amazon Kendra.

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

    • overrideConfiguration

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

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