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

Class SmsMfaConfigType

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

The configuration of multi-factor authentication (MFA) with SMS messages in a user pool.

See Also:

  • Method Details

    • smsAuthenticationMessage

      public final String smsAuthenticationMessage()

      The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.

      Returns:
      The SMS authentication message that will be sent to users with the code they must sign in with. The message must contain the {####} placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn't provided, your user pool sends a default message.

    • smsConfiguration

      public final SmsConfigurationType smsConfiguration()

      User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

      You can set SmsConfiguration in CreateUserPool and UpdateUserPool, or in SetUserPoolMfaConfig.

      Returns:
      User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

      You can set SmsConfiguration in CreateUserPool and UpdateUserPool , or in SetUserPoolMfaConfig.

    • toBuilder

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

    • builder

      public static SmsMfaConfigType.Builder builder()

    • serializableBuilderClass

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