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>

A user's preference for using SMS message multi-factor authentication (MFA). Turns SMS MFA on and off, and can set SMS as preferred when other MFA options are available. You can't turn off SMS MFA for any of your users when MFA is required in your user pool; you can only set the type that your user prefers.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Specifies whether SMS 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 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. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.

      Returns:
      Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.

    • toBuilder

      public SMSMfaSettingsType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<SMSMfaSettingsType.Builder,SMSMfaSettingsType>

    • 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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo