com.amazonaws.services.cognitoidentityprovider.model

Class SetUserMFAPreferenceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.SetUserMFAPreferenceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SetUserMFAPreferenceRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

Set the user's multi-factor authentication (MFA) method preference, including which MFA factors are activated and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts unless device tracking is turned on and the device has been trusted. If you want MFA to be applied selectively based on the assessed risk level of sign-in attempts, deactivate MFA for users and turn on Adaptive Authentication for the user pool.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetUserMFAPreferenceRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccessToken() A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
SMSMfaSettingsType	getSMSMfaSettings() The SMS text message multi-factor authentication (MFA) settings.
SoftwareTokenMfaSettingsType	getSoftwareTokenMfaSettings() The time-based one-time password (TOTP) software token MFA settings.
int	hashCode()
void	setAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
void	setSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings) The SMS text message multi-factor authentication (MFA) settings.
void	setSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) The time-based one-time password (TOTP) software token MFA settings.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SetUserMFAPreferenceRequest	withAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.
SetUserMFAPreferenceRequest	withSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings) The SMS text message multi-factor authentication (MFA) settings.
SetUserMFAPreferenceRequest	withSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings) The time-based one-time password (TOTP) software token MFA settings.

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

SetUserMFAPreferenceRequest

public SetUserMFAPreferenceRequest()

Method Detail

getSMSMfaSettings

public SMSMfaSettingsType getSMSMfaSettings()

The SMS text message multi-factor authentication (MFA) settings.

Returns:

The SMS text message multi-factor authentication (MFA) settings.

setSMSMfaSettings

public void setSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)

The SMS text message multi-factor authentication (MFA) settings.

Parameters:

sMSMfaSettings -

The SMS text message multi-factor authentication (MFA) settings.

withSMSMfaSettings

public SetUserMFAPreferenceRequest withSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)

The SMS text message multi-factor authentication (MFA) settings.

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

Parameters:

sMSMfaSettings -

The SMS text message multi-factor authentication (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 (TOTP) software token MFA settings.

Returns:

The time-based one-time password (TOTP) software token MFA settings.

setSoftwareTokenMfaSettings

public void setSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)

The time-based one-time password (TOTP) software token MFA settings.

Parameters:

softwareTokenMfaSettings -

The time-based one-time password (TOTP) software token MFA settings.

withSoftwareTokenMfaSettings

public SetUserMFAPreferenceRequest withSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)

The time-based one-time password (TOTP) 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 (TOTP) software token MFA settings.

Returns:

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

getAccessToken

public java.lang.String getAccessToken()

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

withAccessToken

public SetUserMFAPreferenceRequest withAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

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

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose MFA preference you want to set.

Returns:

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

toString

public java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object