com.amazonaws.mobileconnectors.cognitoidentityprovider

Class CognitoMfaSettings

java.lang.Object

com.amazonaws.mobileconnectors.cognitoidentityprovider.CognitoMfaSettings

public class CognitoMfaSettings
extends java.lang.Object

Represents user MFA settings in Cognito.

Requires MFA name to instantiate. MFA enabled and preferred states are set to false by default.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SMS_MFA SMS MFA type.
static java.lang.String	TOTP_MFA Software token MFA type.

Constructor Summary

Constructors

Constructor and Description
CognitoMfaSettings(java.lang.String mfaName) Instantiates this class for an MFA.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMfaName() Returns MFA name.
boolean	isEnabled() Returns MFA enabled state.
boolean	isPreferred() Returns preferred state of this MFA.
void	setEnabled(boolean enabled) Sets MFA state.
void	setPreferred(boolean preferred) Sets preferred state for this MFA.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SMS_MFA

public static final java.lang.String SMS_MFA

SMS MFA type.

See Also:

Constant Field Values

TOTP_MFA

public static final java.lang.String TOTP_MFA

Software token MFA type.

See Also:

Constant Field Values

Constructor Detail

CognitoMfaSettings

public CognitoMfaSettings(java.lang.String mfaName)

Instantiates this class for an MFA.

Parameters:

mfaName - Required: The MFA name.

Method Detail

isEnabled

public boolean isEnabled()

Returns MFA enabled state.

Returns:

true if this MFA is enabled.

setEnabled

public void setEnabled(boolean enabled)

Sets MFA state.

Parameters:

enabled - set this to true to enable this MFA.

isPreferred

public boolean isPreferred()

Returns preferred state of this MFA.

Returns:

true if this is set a the preferred MFA.

setPreferred

public void setPreferred(boolean preferred)

Sets preferred state for this MFA.

Parameters:

preferred - true if this MFA should be the preferred.

getMfaName

public java.lang.String getMfaName()

Returns MFA name.

Returns:

MFA name.