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

Class SoftwareTokenMfaSettingsType

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

A user's preference for using time-based one-time password (TOTP) multi-factor authentication (MFA). Turns TOTP MFA on and off, and can set TOTP as preferred when other MFA options are available. You can't turn off TOTP 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 software token 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 software token 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 software token MFA is the preferred MFA method.

      Returns:
      Specifies whether software token MFA is the preferred MFA method.

    • toBuilder

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

    • builder

      public static SoftwareTokenMfaSettingsType.Builder builder()

    • serializableBuilderClass

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