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

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

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

Overview

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
}

The template for verification messages.

Instance Attribute Summary collapse

Instance Attribute Details

#default_email_optionString

The default email option.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5964

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

#email_messageString

The email message template.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5964

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

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

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5964

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

#email_subjectString

The subject line for the email message template.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5964

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

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

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5964

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

#sms_messageString

The SMS message template.

Returns:

  • (String)


5964
5965
5966
5967
5968
5969
5970
5971
5972
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5964

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