Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface UpdateGroupRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>, SdkBuilder<UpdateGroupRequest.Builder,UpdateGroupRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateGroupRequest
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.

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

    • userPoolId

      UpdateGroupRequest.Builder userPoolId(String userPoolId)

      The user pool ID for the user pool.

      Parameters:
      userPoolId - The user pool ID for the user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdateGroupRequest.Builder description(String description)

      A string containing the new description of the group.

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

    • roleArn

      UpdateGroupRequest.Builder roleArn(String roleArn)

      The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.

      Parameters:
      roleArn - The new role Amazon Resource Name (ARN) for the group. This is used for setting the cognito:roles and cognito:preferred_role claims in the token.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • precedence

      UpdateGroupRequest.Builder precedence(Integer precedence)

      The new precedence value for the group. For more information about this parameter, see CreateGroup.

      Parameters:
      precedence - The new precedence value for the group. For more information about this parameter, see CreateGroup.
      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.