com.amazonaws.services.cognitoidp.model

Class SMSMfaSettingsType

java.lang.Object

com.amazonaws.services.cognitoidp.model.SMSMfaSettingsType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The type used for enabling SMS MFA at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is enabled 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 would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SMSMfaSettingsType()

Method Summary

Modifier and Type	Method and Description
SMSMfaSettingsType	clone()
boolean	equals(Object obj)
Boolean	getEnabled() Specifies whether SMS text message MFA is enabled.
Boolean	getPreferredMfa() Specifies whether SMS is the preferred MFA method.
int	hashCode()
Boolean	isEnabled() Specifies whether SMS text message MFA is enabled.
Boolean	isPreferredMfa() Specifies whether SMS is the preferred MFA method.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setEnabled(Boolean enabled) Specifies whether SMS text message MFA is enabled.
void	setPreferredMfa(Boolean preferredMfa) Specifies whether SMS is the preferred MFA method.
String	toString() Returns a string representation of this object.
SMSMfaSettingsType	withEnabled(Boolean enabled) Specifies whether SMS text message MFA is enabled.
SMSMfaSettingsType	withPreferredMfa(Boolean preferredMfa) Specifies whether SMS is the preferred MFA method.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SMSMfaSettingsType

public SMSMfaSettingsType()

Method Detail

setEnabled

public void setEnabled(Boolean enabled)

Specifies whether SMS text message MFA is enabled. If an MFA type is enabled 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 SMS text message MFA is enabled. If an MFA type is enabled 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 Boolean getEnabled()

Specifies whether SMS text message MFA is enabled. If an MFA type is enabled 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 SMS text message MFA is enabled. If an MFA type is enabled 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 SMSMfaSettingsType withEnabled(Boolean enabled)

Specifies whether SMS text message MFA is enabled. If an MFA type is enabled 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 SMS text message MFA is enabled. If an MFA type is enabled 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:

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

isEnabled

public Boolean isEnabled()

Specifies whether SMS text message MFA is enabled. If an MFA type is enabled 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 SMS text message MFA is enabled. If an MFA type is enabled 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.

setPreferredMfa

public void setPreferredMfa(Boolean preferredMfa)

Specifies whether SMS is the preferred MFA method.

Parameters:

preferredMfa - Specifies whether SMS is the preferred MFA method.

getPreferredMfa

public Boolean getPreferredMfa()

Specifies whether SMS is the preferred MFA method.

Returns:

Specifies whether SMS is the preferred MFA method.

withPreferredMfa

public SMSMfaSettingsType withPreferredMfa(Boolean preferredMfa)

Specifies whether SMS is the preferred MFA method.

Parameters:

preferredMfa - Specifies whether SMS is the preferred MFA method.

Returns:

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

isPreferredMfa

public Boolean isPreferredMfa()

Specifies whether SMS is the preferred MFA method.

Returns:

Specifies whether SMS is the preferred MFA method.

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 SMSMfaSettingsType clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.