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

Class AdminSetUserPasswordRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.AdminSetUserPasswordRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AdminSetUserPasswordRequest.Builder,AdminSetUserPasswordRequest>

@Generated("software.amazon.awssdk:codegen")
public final class AdminSetUserPasswordRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<AdminSetUserPasswordRequest.Builder,AdminSetUserPasswordRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdminSetUserPasswordRequest.Builder

Method Summary

Modifier and Type	Method	Description
static AdminSetUserPasswordRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	password()	The new temporary or permanent password that you want to set for the user.
Boolean	permanent()	Set to true to set a password that the user can immediately sign in with.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AdminSetUserPasswordRequest.Builder>	serializableBuilderClass()
AdminSetUserPasswordRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	The username of the user that you want to query or modify.
String	userPoolId()	The ID of the user pool where you want to set the user's password.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userPoolId

public final String userPoolId()

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

Returns:

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

username

public final String username()

The username 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:

The username 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.

password

public final 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.

Returns:

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.

permanent

public final 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.

Returns:

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.

toBuilder

public AdminSetUserPasswordRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminSetUserPasswordRequest.Builder,AdminSetUserPasswordRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static AdminSetUserPasswordRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AdminSetUserPasswordRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo