Interface AdminSetUserPasswordRequest.Builder

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

  • Method Details

    • userPoolId

      AdminSetUserPasswordRequest.Builder userPoolId(String userPoolId)

      The ID of the user pool where you want to set the user's password.

      Parameters:
      userPoolId - The ID of the user pool where you want to set the user's password.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • username

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

    • password

      AdminSetUserPasswordRequest.Builder password(String password)

      The new temporary or permanent password that you want to set for the user. You can't remove the password for a user who already has a password so that they can only sign in with passwordless methods. In this scenario, you must create a new user without a password.

      Parameters:
      password - The new temporary or permanent password that you want to set for the user. You can't remove the password for a user who already has a password so that they can only sign in with passwordless methods. In this scenario, you must create a new user without a password.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • permanent

      AdminSetUserPasswordRequest.Builder permanent(Boolean permanent)

      Set to true to set a password that the user can immediately sign in with. Set to false to set a temporary password that the user must change on their next sign-in.

      Parameters:
      permanent - Set to true to set a password that the user can immediately sign in with. Set to false to set a temporary password that the user must change on their next sign-in.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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