com.amazonaws.services.cognitoidentityprovider.model

Class SoftwareTokenMfaSettingsType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.SoftwareTokenMfaSettingsType

All Implemented Interfaces:

java.io.Serializable

public class SoftwareTokenMfaSettingsType
extends java.lang.Object
implements java.io.Serializable

The type used for enabling software token MFA at the user level. 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SoftwareTokenMfaSettingsType()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.Boolean	getEnabled() Specifies whether software token MFA is activated.
java.lang.Boolean	getPreferredMfa() Specifies whether software token MFA is the preferred MFA method.
int	hashCode()
java.lang.Boolean	isEnabled() Specifies whether software token MFA is activated.
java.lang.Boolean	isPreferredMfa() Specifies whether software token MFA is the preferred MFA method.
void	setEnabled(java.lang.Boolean enabled) Specifies whether software token MFA is activated.
void	setPreferredMfa(java.lang.Boolean preferredMfa) Specifies whether software token MFA is the preferred MFA method.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SoftwareTokenMfaSettingsType	withEnabled(java.lang.Boolean enabled) Specifies whether software token MFA is activated.
SoftwareTokenMfaSettingsType	withPreferredMfa(java.lang.Boolean preferredMfa) Specifies whether software token MFA is the preferred MFA method.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoftwareTokenMfaSettingsType

public SoftwareTokenMfaSettingsType()

Method Detail

isEnabled

public java.lang.Boolean isEnabled()

Specifies whether software token MFA is activated. 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.

Returns:

Specifies whether software token MFA is activated. 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.

getEnabled

public java.lang.Boolean getEnabled()

Specifies whether software token MFA is activated. 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.

Returns:

Specifies whether software token MFA is activated. 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.

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Specifies whether software token MFA is activated. 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.

Parameters:

enabled -

Specifies whether software token MFA is activated. 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.

withEnabled

public SoftwareTokenMfaSettingsType withEnabled(java.lang.Boolean enabled)

Specifies whether software token MFA is activated. 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.

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

Parameters:

enabled -

Specifies whether software token MFA is activated. 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.

Returns:

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

isPreferredMfa

public java.lang.Boolean isPreferredMfa()

Specifies whether software token MFA is the preferred MFA method.

Returns:

Specifies whether software token MFA is the preferred MFA method.

getPreferredMfa

public java.lang.Boolean getPreferredMfa()

Specifies whether software token MFA is the preferred MFA method.

Returns:

Specifies whether software token MFA is the preferred MFA method.

setPreferredMfa

public void setPreferredMfa(java.lang.Boolean preferredMfa)

Specifies whether software token MFA is the preferred MFA method.

Parameters:

preferredMfa -

Specifies whether software token MFA is the preferred MFA method.

withPreferredMfa

public SoftwareTokenMfaSettingsType withPreferredMfa(java.lang.Boolean preferredMfa)

Specifies whether software token MFA is the preferred MFA method.

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

Parameters:

preferredMfa -

Specifies whether software token MFA is the preferred MFA method.

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