Class: AWSCDK::SES::CfnCustomVerificationEmailTemplateProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses/cfn_custom_verification_email_template_props.rb

Overview

Properties for defining a CfnCustomVerificationEmailTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(failure_redirection_url:, from_email_address:, success_redirection_url:, template_content:, template_name:, template_subject:, tags: nil) ⇒ CfnCustomVerificationEmailTemplateProps

Returns a new instance of CfnCustomVerificationEmailTemplateProps.

Parameters:

  • failure_redirection_url (String) —

    The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

  • from_email_address (String) —

    The email address that the custom verification email is sent from.

  • success_redirection_url (String) —

    The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

  • template_content (String) —

    The content of the custom verification email.

  • template_name (String) —

    The name of the custom verification email template.

  • template_subject (String) —

    The subject line of the custom verification email.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    The tags (keys and values) associated with the tenant.



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 16

def initialize(failure_redirection_url:, from_email_address:, success_redirection_url:, template_content:, template_name:, template_subject:, tags: nil)
  @failure_redirection_url = failure_redirection_url
  Jsii::Type.check_type(@failure_redirection_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "failureRedirectionUrl")
  @from_email_address = from_email_address
  Jsii::Type.check_type(@from_email_address, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fromEmailAddress")
  @success_redirection_url = success_redirection_url
  Jsii::Type.check_type(@success_redirection_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "successRedirectionUrl")
  @template_content = template_content
  Jsii::Type.check_type(@template_content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateContent")
  @template_name = template_name
  Jsii::Type.check_type(@template_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateName")
  @template_subject = template_subject
  Jsii::Type.check_type(@template_subject, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateSubject")
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#failure_redirection_url ⇒ String (readonly)

The URL that the recipient of the verification email is sent to if his or her address is not successfully verified.

Returns:

  • (String)

See Also:



37
38
39
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 37

def failure_redirection_url
  @failure_redirection_url
end

#from_email_address ⇒ String (readonly)

The email address that the custom verification email is sent from.

Returns:

  • (String)

See Also:



42
43
44
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 42

def from_email_address
  @from_email_address
end

#success_redirection_url ⇒ String (readonly)

The URL that the recipient of the verification email is sent to if his or her address is successfully verified.

Returns:

  • (String)

See Also:



47
48
49
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 47

def success_redirection_url
  @success_redirection_url
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

The tags (keys and values) associated with the tenant.

Returns:

See Also:



69
70
71
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 69

def tags
  @tags
end

#template_content ⇒ String (readonly)

The content of the custom verification email.

The total size of the email must be less than 10 MB. The message body may contain HTML, with some limitations.

Returns:

  • (String)

See Also:



54
55
56
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 54

def template_content
  @template_content
end

#template_name ⇒ String (readonly)

The name of the custom verification email template.

Returns:

  • (String)

See Also:



59
60
61
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 59

def template_name
  @template_name
end

#template_subject ⇒ String (readonly)

The subject line of the custom verification email.

Returns:

  • (String)

See Also:



64
65
66
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 64

def template_subject
  @template_subject
end

Class Method Details

.jsii_properties ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 71

def self.jsii_properties
  {
    :failure_redirection_url => "failureRedirectionUrl",
    :from_email_address => "fromEmailAddress",
    :success_redirection_url => "successRedirectionUrl",
    :template_content => "templateContent",
    :template_name => "templateName",
    :template_subject => "templateSubject",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'ses/cfn_custom_verification_email_template_props.rb', line 83

def to_jsii
  result = {}
  result.merge!({
    "failureRedirectionUrl" => @failure_redirection_url,
    "fromEmailAddress" => @from_email_address,
    "successRedirectionUrl" => @success_redirection_url,
    "templateContent" => @template_content,
    "templateName" => @template_name,
    "templateSubject" => @template_subject,
    "tags" => @tags,
  })
  result.compact
end