@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SMSMfaSettingsType extends Object implements Serializable, Cloneable, StructuredPojo
The type used for enabling SMS multi-factor authentication (MFA) at the user level. Phone numbers don't need to be verified to be used for SMS MFA. 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 would like 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.
Constructor and Description |
---|
SMSMfaSettingsType() |
Modifier and Type | Method and Description |
---|---|
SMSMfaSettingsType |
clone() |
boolean |
equals(Object obj) |
Boolean |
getEnabled()
Specifies whether SMS text message MFA is activated.
|
Boolean |
getPreferredMfa()
Specifies whether SMS is the preferred MFA method.
|
int |
hashCode() |
Boolean |
isEnabled()
Specifies whether SMS text message MFA is activated.
|
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 activated.
|
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 activated.
|
SMSMfaSettingsType |
withPreferredMfa(Boolean preferredMfa)
Specifies whether SMS is the preferred MFA method.
|
public void setEnabled(Boolean enabled)
Specifies whether SMS text message 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.
enabled
- Specifies whether SMS text message 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.public Boolean getEnabled()
Specifies whether SMS text message 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.
public SMSMfaSettingsType withEnabled(Boolean enabled)
Specifies whether SMS text message 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.
enabled
- Specifies whether SMS text message 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.public Boolean isEnabled()
Specifies whether SMS text message 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.
public void setPreferredMfa(Boolean preferredMfa)
Specifies whether SMS is the preferred MFA method.
preferredMfa
- Specifies whether SMS is the preferred MFA method.public Boolean getPreferredMfa()
Specifies whether SMS is the preferred MFA method.
public SMSMfaSettingsType withPreferredMfa(Boolean preferredMfa)
Specifies whether SMS is the preferred MFA method.
preferredMfa
- Specifies whether SMS is the preferred MFA method.public Boolean isPreferredMfa()
Specifies whether SMS is the preferred MFA method.
public String toString()
toString
in class Object
Object.toString()
public SMSMfaSettingsType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.