Interface UpdateGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>, SdkBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateGroupRequest
@Mutable @NotThreadSafe public static interface UpdateGroupRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>

  • Method Details

    • groupName

      UpdateGroupRequest.Builder groupName(String groupName)

      The name of the group that you want to update.

      Parameters:
      groupName - The name of the group that you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userPoolId

      UpdateGroupRequest.Builder userPoolId(String userPoolId)

      The ID of the user pool that contains the group you want to update.

      Parameters:
      userPoolId - The ID of the user pool that contains the group you want to update.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateGroupRequest.Builder description(String description)

      A new description of the existing group.

      Parameters:
      description - A new description of the existing group.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • roleArn

      UpdateGroupRequest.Builder roleArn(String roleArn)

      The Amazon Resource Name (ARN) of an IAM role that you want to associate with the group. The role assignment contributes to the cognito:roles and cognito:preferred_role claims in group members' tokens.

      Parameters:
      roleArn - The Amazon Resource Name (ARN) of an IAM role that you want to associate with the group. The role assignment contributes to the cognito:roles and cognito:preferred_role claims in group members' tokens.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • precedence

      UpdateGroupRequest.Builder precedence(Integer precedence)

      A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

      Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

      The default Precedence value is null. The maximum Precedence value is 2^31-1.

      Parameters:
      precedence - A non-negative integer value that specifies the precedence of this group relative to the other groups that a user can belong to in the user pool. Zero is the highest precedence value. Groups with lower Precedence values take precedence over groups with higher or null Precedence values. If a user belongs to two or more groups, it is the group with the lowest precedence value whose role ARN is given in the user's tokens for the cognito:roles and cognito:preferred_role claims.

      Two groups can have the same Precedence value. If this happens, neither group takes precedence over the other. If two groups with the same Precedence have the same role ARN, that role is used in the cognito:preferred_role claim in tokens for users in each group. If the two groups have different role ARNs, the cognito:preferred_role claim isn't set in users' tokens.

      The default Precedence value is null. The maximum Precedence value is 2^31-1.

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

    • overrideConfiguration

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

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