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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#default_email_optionString

The default email option.

Returns:

  • (String)


10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10243

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 email message template.

Returns:

  • (String)


10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10243

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.

Returns:

  • (String)


10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10243

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.

Returns:

  • (String)


10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10243

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.

Returns:

  • (String)


10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10243

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 SMS message template.

Returns:

  • (String)


10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 10243

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