Interface AdminAddUserToGroupRequest.Builder

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

  • Method Details

    • userPoolId

      AdminAddUserToGroupRequest.Builder userPoolId(String userPoolId)

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

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

    • username

      AdminAddUserToGroupRequest.Builder username(String username)

      The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

      Parameters:
      username - The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupName

      AdminAddUserToGroupRequest.Builder groupName(String groupName)

      The name of the group that you want to add your user to.

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

    • overrideConfiguration

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

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