Class VerificationMessageTemplateType
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VerificationMessageTemplateType.Builder,
VerificationMessageTemplateType>
The template for verification messages.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DefaultEmailOptionType
The default email option.final String
The default email option.final String
The template for email messages that Amazon Cognito sends to your users.final String
The email message template for sending a confirmation link to the user.final String
The subject line for the email message template.final String
The subject line for the email message template for sending a confirmation link to the user.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
static Class
<? extends VerificationMessageTemplateType.Builder> final String
The template for SMS messages that Amazon Cognito sends to your users.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The template for email messages that Amazon Cognito sends to your users. You can set an
EmailMessage
template only if the value of EmailSendingAccount isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, 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 isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.
-
emailSubject
The subject line for the email message template. You can set an
EmailSubject
template only if the value of EmailSendingAccount isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, 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 isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.
-
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 isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, 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 isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.
-
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 isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, 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 isDEVELOPER
. When your EmailSendingAccount isDEVELOPER
, your user pool sends email messages with your own Amazon SES configuration.
-
defaultEmailOption
The default email option.
If the service returns an enum value that is not available in the current SDK version,
defaultEmailOption
will returnDefaultEmailOptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefaultEmailOptionAsString()
.- Returns:
- The default email option.
- See Also:
-
defaultEmailOptionAsString
The default email option.
If the service returns an enum value that is not available in the current SDK version,
defaultEmailOption
will returnDefaultEmailOptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdefaultEmailOptionAsString()
.- Returns:
- The default email option.
- See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<VerificationMessageTemplateType.Builder,
VerificationMessageTemplateType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-