class Aws::CognitoIdentityProvider::Types::VerificationMessageTemplateType

The template for verification messages.

@note When making an API call, you may pass VerificationMessageTemplateType

data as a hash:

    {
      sms_message: "SmsVerificationMessageType",
      email_message: "EmailVerificationMessageType",
      email_subject: "EmailVerificationSubjectType",
      email_message_by_link: "EmailVerificationMessageByLinkType",
      email_subject_by_link: "EmailVerificationSubjectByLinkType",
      default_email_option: "CONFIRM_WITH_LINK", # accepts CONFIRM_WITH_LINK, CONFIRM_WITH_CODE
    }

@!attribute [rw] sms_message

The SMS message template.
@return [String]

@!attribute [rw] email_message

The email message template. EmailMessage is allowed only if [
EmailSendingAccount][1] is DEVELOPER.

[1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
@return [String]

@!attribute [rw] email_subject

The subject line for the email message template. EmailSubject is
allowed only if [EmailSendingAccount][1] is DEVELOPER.

[1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
@return [String]

@!attribute [rw] email_message_by_link

The email message template for sending a confirmation link to the
user. EmailMessageByLink is allowed only if [
EmailSendingAccount][1] is DEVELOPER.

[1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
@return [String]

@!attribute [rw] email_subject_by_link

The subject line for the email message template for sending a
confirmation link to the user. EmailSubjectByLink is allowed only [
EmailSendingAccount][1] is DEVELOPER.

[1]: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount
@return [String]

@!attribute [rw] default_email_option

The default email option.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/VerificationMessageTemplateType AWS API Documentation

Constants

SENSITIVE