com.amazonaws.services.cognitoidentityprovider.model

Class AdminSetUserMFAPreferenceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserMFAPreferenceRequest

All Implemented Interfaces:

Serializable, Cloneable

public class AdminSetUserMFAPreferenceRequest
extends AmazonWebServiceRequest
implements Serializable

Sets the user's multi-factor authentication (MFA) preference.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminSetUserMFAPreferenceRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
SMSMfaSettingsType	getSMSMfaSettings() The SMS text message MFA settings.
SoftwareTokenMfaSettingsType	getSoftwareTokenMfaSettings() The time-based one-time password software token MFA settings.
String	getUsername() The user pool username or alias.
String	getUserPoolId() The user pool ID.
int	hashCode()
void	setSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings) The SMS text message MFA settings.
void	setSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) The time-based one-time password software token MFA settings.
void	setUsername(String username) The user pool username or alias.
void	setUserPoolId(String userPoolId) The user pool ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminSetUserMFAPreferenceRequest	withSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings) The SMS text message MFA settings.
AdminSetUserMFAPreferenceRequest	withSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) The time-based one-time password software token MFA settings.
AdminSetUserMFAPreferenceRequest	withUsername(String username) The user pool username or alias.
AdminSetUserMFAPreferenceRequest	withUserPoolId(String userPoolId) The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminSetUserMFAPreferenceRequest

public AdminSetUserMFAPreferenceRequest()

Method Detail

getSMSMfaSettings

public SMSMfaSettingsType getSMSMfaSettings()

The SMS text message MFA settings.

Returns:

The SMS text message MFA settings.

setSMSMfaSettings

public void setSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)

The SMS text message MFA settings.

Parameters:

sMSMfaSettings -

The SMS text message MFA settings.

withSMSMfaSettings

public AdminSetUserMFAPreferenceRequest withSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)

The SMS text message MFA settings.

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

Parameters:

sMSMfaSettings -

The SMS text message MFA settings.

Returns:

A reference to this updated object so that method calls can be chained together.

getSoftwareTokenMfaSettings

public SoftwareTokenMfaSettingsType getSoftwareTokenMfaSettings()

The time-based one-time password software token MFA settings.

Returns:

The time-based one-time password software token MFA settings.

setSoftwareTokenMfaSettings

public void setSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)

The time-based one-time password software token MFA settings.

Parameters:

softwareTokenMfaSettings -

The time-based one-time password software token MFA settings.

withSoftwareTokenMfaSettings

public AdminSetUserMFAPreferenceRequest withSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)

The time-based one-time password software token MFA settings.

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

Parameters:

softwareTokenMfaSettings -

The time-based one-time password software token MFA settings.

Returns:

A reference to this updated object so that method calls can be chained together.

getUsername

public String getUsername()

The user pool username or alias.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user pool username or alias.

setUsername

public void setUsername(String username)

The user pool username or alias.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user pool username or alias.

withUsername

public AdminSetUserMFAPreferenceRequest withUsername(String username)

The user pool username or alias.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user pool username or alias.

Returns:

A reference to this updated object so that method calls can be chained together.

getUserPoolId

public String getUserPoolId()

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The user pool ID.

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID.

withUserPoolId

public AdminSetUserMFAPreferenceRequest withUserPoolId(String userPoolId)

The user pool ID.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The user pool ID.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object