Class: AWSCDK::SESActions::BounceProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ses_actions/bounce_props.rb

Overview

Construction properties for a bounce action.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sender:, template:, topic: nil) ⇒ BounceProps

Returns a new instance of BounceProps.

Parameters:

  • sender (String) —

    The email address of the sender of the bounced email.

  • template (AWSCDK::SESActions::BounceTemplate) —

    The template containing the message, reply code and status code.

  • topic (AWSCDK::SNS::ITopic, nil) (defaults to: nil) —

    The SNS topic to notify when the bounce action is taken.



10
11
12
13
14
15
16
17
 
# File 'ses_actions/bounce_props.rb', line 10

def initialize(sender:, template:, topic: nil)
  @sender = sender
  Jsii::Type.check_type(@sender, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sender")
  @template = template
  Jsii::Type.check_type(@template, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzX2FjdGlvbnMuQm91bmNlVGVtcGxhdGUifQ==")), "template")
  @topic = topic
  Jsii::Type.check_type(@topic, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLklUb3BpYyJ9")), "topic") unless @topic.nil?
end

Instance Attribute Details

#sender ⇒ String (readonly)

The email address of the sender of the bounced email.

This is the address from which the bounce message will be sent.

Returns:

  • (String) 


25
26
27
 
# File 'ses_actions/bounce_props.rb', line 25

def sender
  @sender
end

#template ⇒ AWSCDK::SESActions::BounceTemplate (readonly)

The template containing the message, reply code and status code.

Returns:



29
30
31
 
# File 'ses_actions/bounce_props.rb', line 29

def template
  @template
end

#topic ⇒ AWSCDK::SNS::ITopic? (readonly)

Note:

Default: no notification

The SNS topic to notify when the bounce action is taken.

Returns:



34
35
36
 
# File 'ses_actions/bounce_props.rb', line 34

def topic
  @topic
end

Class Method Details

.jsii_properties ⇒ Object 



36
37
38
39
40
41
42
 
# File 'ses_actions/bounce_props.rb', line 36

def self.jsii_properties
  {
    :sender => "sender",
    :template => "template",
    :topic => "topic",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



44
45
46
47
48
49
50
51
52
 
# File 'ses_actions/bounce_props.rb', line 44

def to_jsii
  result = {}
  result.merge!({
    "sender" => @sender,
    "template" => @template,
    "topic" => @topic,
  })
  result.compact
end