Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SMSMfaSettingsType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.SMSMfaSettingsType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SMSMfaSettingsType.Builder,SMSMfaSettingsType>
@Generated("software.amazon.awssdk:codegen") public final class SMSMfaSettingsType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SMSMfaSettingsType.Builder,SMSMfaSettingsType>

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.

See Also:

  • Method Details

    • enabled

      public final 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.

      Returns:
      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.

    • preferredMfa

      public final Boolean preferredMfa()

      Specifies whether SMS is the preferred MFA method.

      Returns:
      Specifies whether SMS is the preferred MFA method.

    • toBuilder

      public SMSMfaSettingsType.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<SMSMfaSettingsType.Builder,SMSMfaSettingsType>
      Returns:
      a builder for type T

    • builder

      public static SMSMfaSettingsType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SMSMfaSettingsType.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.