com.amazonaws.services.cognitoidp.model

Class AdminSetUserPasswordRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.AdminSetUserPasswordRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminSetUserPasswordRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
AdminSetUserPasswordRequest()

Method Summary

Modifier and Type	Method and Description
AdminSetUserPasswordRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getPassword() The password for the user.
Boolean	getPermanent() True if the password is permanent, False if it is temporary.
String	getUsername() The username of the user that you want to query or modify.
String	getUserPoolId() The user pool ID for the user pool where you want to set the user's password.
int	hashCode()
Boolean	isPermanent() True if the password is permanent, False if it is temporary.
void	setPassword(String password) The password for the user.
void	setPermanent(Boolean permanent) True if the password is permanent, False if it is temporary.
void	setUsername(String username) The username of the user that you want to query or modify.
void	setUserPoolId(String userPoolId) The user pool ID for the user pool where you want to set the user's password.
String	toString() Returns a string representation of this object.
AdminSetUserPasswordRequest	withPassword(String password) The password for the user.
AdminSetUserPasswordRequest	withPermanent(Boolean permanent) True if the password is permanent, False if it is temporary.
AdminSetUserPasswordRequest	withUsername(String username) The username of the user that you want to query or modify.
AdminSetUserPasswordRequest	withUserPoolId(String userPoolId) The user pool ID for the user pool where you want to set the user's password.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminSetUserPasswordRequest

public AdminSetUserPasswordRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

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

Parameters:

userPoolId - The user pool ID for the user pool where you want to set the user's password.

getUserPoolId

public String getUserPoolId()

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

Returns:

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

withUserPoolId

public AdminSetUserPasswordRequest withUserPoolId(String userPoolId)

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

Parameters:

userPoolId - The user pool ID for 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.

setUsername

public void setUsername(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.

Parameters:

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.

getUsername

public String getUsername()

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.

withUsername

public AdminSetUserPasswordRequest withUsername(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.

Parameters:

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:

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

setPassword

public void setPassword(String password)

The password for the user.

Parameters:

password - The password for the user.

getPassword

public String getPassword()

The password for the user.

Returns:

The password for the user.

withPassword

public AdminSetUserPasswordRequest withPassword(String password)

The password for the user.

Parameters:

password - The password for the user.

Returns:

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

setPermanent

public void setPermanent(Boolean permanent)

True if the password is permanent, False if it is temporary.

Parameters:

permanent - True if the password is permanent, False if it is temporary.

getPermanent

public Boolean getPermanent()

True if the password is permanent, False if it is temporary.

Returns:

True if the password is permanent, False if it is temporary.

withPermanent

public AdminSetUserPasswordRequest withPermanent(Boolean permanent)

True if the password is permanent, False if it is temporary.

Parameters:

permanent - True if the password is permanent, False if it is temporary.

Returns:

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

isPermanent

public Boolean isPermanent()

True if the password is permanent, False if it is temporary.

Returns:

True if the password is permanent, False if it is temporary.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AdminSetUserPasswordRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()