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

Class EmailMfaConfigType

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

Sets or shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.

See Also:

  • Method Details

    • message

      public final String message()

      The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.

      Returns:
      The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. The message must contain the {####} placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don't provide this parameter, Amazon Cognito sends messages in the default format.

    • subject

      public final String subject()

      The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.

      Returns:
      The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.

    • toBuilder

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

    • builder

      public static EmailMfaConfigType.Builder builder()

    • serializableBuilderClass

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