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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::VerificationMessageTemplateType

Defined in:

gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The template for verification messages.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_email_option ⇒ String

  The default email option.

• #email_message ⇒ String

  The template for email messages that Amazon Cognito sends to your users.

• #email_message_by_link ⇒ String

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

• #email_subject ⇒ 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.

• #sms_message ⇒ String

  The template for SMS messages that Amazon Cognito sends to your users.

Instance Attribute Details

#default_email_option ⇒ String

The default email option.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10738

class VerificationMessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject,
  :email_message_by_link,
  :email_subject_by_link,
  :default_email_option)
  SENSITIVE = []
  include Aws::Structure
end

#email_message ⇒ String

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:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10738

class VerificationMessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject,
  :email_message_by_link,
  :email_subject_by_link,
  :default_email_option)
  SENSITIVE = []
  include Aws::Structure
end

#email_message_by_link ⇒ String

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:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10738

class VerificationMessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject,
  :email_message_by_link,
  :email_subject_by_link,
  :default_email_option)
  SENSITIVE = []
  include Aws::Structure
end

#email_subject ⇒ String

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:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10738

class VerificationMessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject,
  :email_message_by_link,
  :email_subject_by_link,
  :default_email_option)
  SENSITIVE = []
  include Aws::Structure
end

#email_subject_by_link ⇒ String

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:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10738

class VerificationMessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject,
  :email_message_by_link,
  :email_subject_by_link,
  :default_email_option)
  SENSITIVE = []
  include Aws::Structure
end

#sms_message ⇒ String

The template for SMS messages that Amazon Cognito sends to your users.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10738

class VerificationMessageTemplateType < Struct.new(
  :sms_message,
  :email_message,
  :email_subject,
  :email_message_by_link,
  :email_subject_by_link,
  :default_email_option)
  SENSITIVE = []
  include Aws::Structure
end