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

Class MFAOptionType

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

This data type is no longer supported. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

See Also:

  • Method Details

    • deliveryMedium

      public final DeliveryMediumType deliveryMedium()

      The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

      If the service returns an enum value that is not available in the current SDK version, deliveryMedium will return DeliveryMediumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryMediumAsString().

      Returns:
      The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.
      See Also:

    • deliveryMediumAsString

      public final String deliveryMediumAsString()

      The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

      If the service returns an enum value that is not available in the current SDK version, deliveryMedium will return DeliveryMediumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deliveryMediumAsString().

      Returns:
      The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.
      See Also:

    • attributeName

      public final String attributeName()

      The attribute name of the MFA option type. The only valid value is phone_number.

      Returns:
      The attribute name of the MFA option type. The only valid value is phone_number.

    • toBuilder

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

    • builder

      public static MFAOptionType.Builder builder()

    • serializableBuilderClass

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