Class: AWSCDK::SES::ConfigurationSetEventDestinationProps

Inherits:
ConfigurationSetEventDestinationOptions
  • Object
show all
Defined in:
ses/configuration_set_event_destination_props.rb

Overview

Properties for a configuration set event destination.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(destination:, configuration_set_event_destination_name: nil, enabled: nil, events: nil, configuration_set:) ⇒ ConfigurationSetEventDestinationProps

Returns a new instance of ConfigurationSetEventDestinationProps.

Parameters:

  • destination (AWSCDK::SES::EventDestination) —

    The event destination.

  • configuration_set_event_destination_name (String, nil) (defaults to: nil) —

    A name for the configuration set event destination.

  • enabled (Boolean, nil) (defaults to: nil) —

    Whether Amazon SES publishes events to this destination.

  • events (Array<AWSCDK::SES::EmailSendingEvent>, nil) (defaults to: nil) —

    The type of email sending events to publish to the event destination.

  • configuration_set (AWSCDK::Interfaces::AWSSES::IConfigurationSetRef) —

    The configuration set that contains the event destination.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'ses/configuration_set_event_destination_props.rb', line 12

def initialize(destination:, configuration_set_event_destination_name: nil, enabled: nil, events: nil, configuration_set:)
  @destination = destination
  Jsii::Type.check_type(@destination, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkV2ZW50RGVzdGluYXRpb24ifQ==")), "destination")
  @configuration_set_event_destination_name = configuration_set_event_destination_name
  Jsii::Type.check_type(@configuration_set_event_destination_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "configurationSetEventDestinationName") unless @configuration_set_event_destination_name.nil?
  @enabled = enabled
  Jsii::Type.check_type(@enabled, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enabled") unless @enabled.nil?
  @events = events
  Jsii::Type.check_type(@events, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuRW1haWxTZW5kaW5nRXZlbnQifSwia2luZCI6ImFycmF5In19")), "events") unless @events.nil?
  @configuration_set = configuration_set
  Jsii::Type.check_type(@configuration_set, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19zZXMuSUNvbmZpZ3VyYXRpb25TZXRSZWYifQ==")), "configurationSet")
end

Instance Attribute Details

#configuration_set ⇒ AWSCDK::Interfaces::AWSSES::IConfigurationSetRef (readonly)

The configuration set that contains the event destination.

Returns:



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

def configuration_set
  @configuration_set
end

#configuration_set_event_destination_name ⇒ String? (readonly)

Note:

Default: - a CloudFormation generated name

A name for the configuration set event destination.

Returns:

  • (String, nil) 


33
34
35
 
# File 'ses/configuration_set_event_destination_props.rb', line 33

def configuration_set_event_destination_name
  @configuration_set_event_destination_name
end

#destination ⇒ AWSCDK::SES::EventDestination (readonly)

The event destination.

Returns:



28
29
30
 
# File 'ses/configuration_set_event_destination_props.rb', line 28

def destination
  @destination
end

#enabled ⇒ Boolean? (readonly)

Note:

Default: true

Whether Amazon SES publishes events to this destination.

Returns:

  • (Boolean, nil) 


38
39
40
 
# File 'ses/configuration_set_event_destination_props.rb', line 38

def enabled
  @enabled
end

#events ⇒ Array<AWSCDK::SES::EmailSendingEvent>? (readonly)

Note:

Default: - send all event types

The type of email sending events to publish to the event destination.

Returns:



43
44
45
 
# File 'ses/configuration_set_event_destination_props.rb', line 43

def events
  @events
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'ses/configuration_set_event_destination_props.rb', line 49

def self.jsii_properties
  {
    :destination => "destination",
    :configuration_set_event_destination_name => "configurationSetEventDestinationName",
    :enabled => "enabled",
    :events => "events",
    :configuration_set => "configurationSet",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'ses/configuration_set_event_destination_props.rb', line 59

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "destination" => @destination,
    "configurationSetEventDestinationName" => @configuration_set_event_destination_name,
    "enabled" => @enabled,
    "events" => @events,
    "configurationSet" => @configuration_set,
  })
  result.compact
end