java.lang.Object
- software.amazon.awssdk.services.cognitoidentityprovider.model.VerificationMessageTemplateType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<VerificationMessageTemplateType.Builder,VerificationMessageTemplateType>
```
@Generated("software.amazon.awssdk:codegen")
public final class VerificationMessageTemplateType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<VerificationMessageTemplateType.Builder,VerificationMessageTemplateType>
```
The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface VerificationMessageTemplateType.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static VerificationMessageTemplateType.Builder`	`builder()`
`DefaultEmailOptionType`	`defaultEmailOption()`	The configuration of verification emails to contain a clickable link or a verification code.
`String`	`defaultEmailOptionAsString()`	The configuration of verification emails to contain a clickable link or a verification code.
`String`	`emailMessage()`	The template for email messages that Amazon Cognito sends to your users.
`String`	`emailMessageByLink()`	The email message template for sending a confirmation link to the user.
`String`	`emailSubject()`	The subject line for the email message template.
`String`	`emailSubjectByLink()`	The subject line for the email message template for sending a confirmation link to the user.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends VerificationMessageTemplateType.Builder>`	`serializableBuilderClass()`
`String`	`smsMessage()`	The template for SMS messages that Amazon Cognito sends to your users.
`VerificationMessageTemplateType.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
  - smsMessage
```
public final String smsMessage()
```
    The template for SMS messages that Amazon Cognito sends to your users.
    
    Returns:
    
    The template for SMS messages that Amazon Cognito sends to your users.
  - emailMessage
```
public final String emailMessage()
```
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The template for email messages that Amazon Cognito sends to your users. You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - emailSubject
```
public final String emailSubject()
```
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The subject line for the email message template. You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - emailMessageByLink
```
public final String emailMessageByLink()
```
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The email message template for sending a confirmation link to the user. You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - emailSubjectByLink
```
public final String emailSubjectByLink()
```
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
    
    Returns:
    
    The subject line for the email message template for sending a confirmation link to the user. You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER. When your EmailSendingAccount is DEVELOPER, your user pool sends email messages with your own Amazon SES configuration.
  - defaultEmailOption
```
public final DefaultEmailOptionType defaultEmailOption()
```
    The configuration of verification emails to contain a clickable link or a verification code.
    
    For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.
    
    If the service returns an enum value that is not available in the current SDK version, defaultEmailOption will return DefaultEmailOptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultEmailOptionAsString().
    
    Returns:
    
    The configuration of verification emails to contain a clickable link or a verification code.
    
    For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.
    
    See Also:
    
    DefaultEmailOptionType
  - defaultEmailOptionAsString
```
public final String defaultEmailOptionAsString()
```
    The configuration of verification emails to contain a clickable link or a verification code.
    
    For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.
    
    If the service returns an enum value that is not available in the current SDK version, defaultEmailOption will return DefaultEmailOptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from defaultEmailOptionAsString().
    
    Returns:
    
    The configuration of verification emails to contain a clickable link or a verification code.
    
    For link, your template body must contain link text in the format {##Click here##}. "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####}.
    
    See Also:
    
    DefaultEmailOptionType
  - toBuilder
```
public VerificationMessageTemplateType.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<VerificationMessageTemplateType.Builder,VerificationMessageTemplateType>
  - builder
```
public static VerificationMessageTemplateType.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends VerificationMessageTemplateType.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

Class VerificationMessageTemplateType

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

smsMessage

emailMessage

emailSubject

emailMessageByLink

emailSubjectByLink

defaultEmailOption

defaultEmailOptionAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField