You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::VerificationMessageTemplateType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing VerificationMessageTemplateType as input to an Aws::Client method, you can use a vanilla 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
}

The template for verification messages.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#default_email_option ⇒ String

The default email option.

Possible values:

  • CONFIRM_WITH_LINK
  • CONFIRM_WITH_CODE

Returns:

  • (String) —

    The default email option.

#email_message ⇒ String

The email message template.

Returns:

  • (String) —

    The email message template.

#email_message_by_link ⇒ String

The email message template for sending a confirmation link to the user.

Returns:

  • (String) —

    The email message template for sending a confirmation link to the user.

#email_subject ⇒ String

The subject line for the email message template.

Returns:

  • (String) —

    The subject line for the email message template.

#email_subject_by_link ⇒ String

The subject line for the email message template for sending a confirmation link to the user.

Returns:

  • (String) —

    The subject line for the email message template for sending a confirmation link to the user.

#sms_message ⇒ String

The SMS message template.

Returns:

  • (String) —

    The SMS message template.