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 user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

This data type is a request parameter of SetUserPoolMfaConfig and a response parameter of GetUserPoolMfaConfig.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EmailMfaConfigType.Builder

Method Summary

Modifier and Type	Method	Description
static EmailMfaConfigType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	message()	The template for the email message that your user pool sends to users with a code for MFA and sign-in with an email OTP.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EmailMfaConfigType.Builder>	serializableBuilderClass()
String	subject()	The subject of the email message that your user pool sends to users with a code for MFA and email OTP sign-in.
EmailMfaConfigType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

message

public final String message()

The template for the email message that your user pool sends to users with a code for MFA and sign-in with an email OTP. 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 message that your user pool sends to users with a code for MFA and sign-in with an email OTP. 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 message that your user pool sends to users with a code for MFA and email OTP sign-in.

Returns:

The subject of the email message that your user pool sends to users with a code 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