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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The template for verification messages.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_email_optionString

The default email option.

Returns:

  • (String)


9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9643

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_messageString

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)


9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9643

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

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)


9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9643

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_subjectString

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)


9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9643

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

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)


9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9643

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_messageString

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

Returns:

  • (String)


9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 9643

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