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

Class EmailMfaSettingsType

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

User preferences for multi-factor authentication with email messages. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Specifies whether email message MFA is active for a user. When the value of this parameter is Enabled, 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 email message MFA is active for a user. When the value of this parameter is Enabled, 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 email message MFA is the user's preferred method.

      Returns:
      Specifies whether email message MFA is the user's preferred method.

    • toBuilder

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

    • builder

      public static EmailMfaSettingsType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EmailMfaSettingsType.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