Class: AWSCDK::SES::EventDestination

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

Overview

An event destination.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ EventDestination

Returns a new instance of EventDestination.



8
9
10
 
# File 'ses/event_destination.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.cloud_watch_dimensions(dimensions) ⇒ AWSCDK::SES::EventDestination

Use CloudWatch dimensions as event destination.

Parameters:

Returns:

  • (AWSCDK::SES::EventDestination) 


25
26
27
28
29
 
# File 'ses/event_destination.rb', line 25

def self.cloud_watch_dimensions(dimensions)
  dimensions = dimensions.is_a?(Array) ? dimensions.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::SES::CloudWatchDimension.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : dimensions
  Jsii::Type.check_type(dimensions, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zZXMuQ2xvdWRXYXRjaERpbWVuc2lvbiJ9LCJraW5kIjoiYXJyYXkifX0=")), "dimensions")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.EventDestination", "cloudWatchDimensions", [dimensions])
end

.event_bus(event_bus) ⇒ AWSCDK::SES::EventDestination

Use Event Bus as event destination.

Parameters:

Returns:

  • (AWSCDK::SES::EventDestination) 


35
36
37
38
 
# File 'ses/event_destination.rb', line 35

def self.event_bus(event_bus)
  Jsii::Type.check_type(event_bus, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19ldmVudHMuSUV2ZW50QnVzUmVmIn0=")), "eventBus")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.EventDestination", "eventBus", [event_bus])
end

.firehose_delivery_stream(stream) ⇒ AWSCDK::SES::EventDestination

Use Firehose Delivery Stream as event destination.

Parameters:

Returns:

  • (AWSCDK::SES::EventDestination) 


44
45
46
47
48
 
# File 'ses/event_destination.rb', line 44

def self.firehose_delivery_stream(stream)
  stream = stream.is_a?(Hash) ? ::AWSCDK::SES::FirehoseDeliveryStreamDestination.new(**stream.transform_keys(&:to_sym)) : stream
  Jsii::Type.check_type(stream, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VzLkZpcmVob3NlRGVsaXZlcnlTdHJlYW1EZXN0aW5hdGlvbiJ9")), "stream")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.EventDestination", "firehoseDeliveryStream", [stream])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
19
 
# File 'ses/event_destination.rb', line 12

def self.jsii_overridable_methods
  {
    :bus => { kind: :property, name: "bus", is_optional: true },
    :dimensions => { kind: :property, name: "dimensions", is_optional: true },
    :stream => { kind: :property, name: "stream", is_optional: true },
    :topic => { kind: :property, name: "topic", is_optional: true },
  }
end

.sns_topic(topic) ⇒ AWSCDK::SES::EventDestination

Use a SNS topic as event destination.

Parameters:

Returns:

  • (AWSCDK::SES::EventDestination) 


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

def self.sns_topic(topic)
  Jsii::Type.check_type(topic, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc25zLklUb3BpYyJ9")), "topic")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ses.EventDestination", "snsTopic", [topic])
end

Instance Method Details

#bus ⇒ AWSCDK::Interfaces::AWSEvents::IEventBusRef?

Note:

Default: - do not send events to Event bus

Use Event Bus as event destination.

Returns:



63
64
65
 
# File 'ses/event_destination.rb', line 63

def bus()
  jsii_get_property("bus")
end

#dimensions ⇒ Array<AWSCDK::SES::CloudWatchDimension>?

Note:

Default: - do not send events to CloudWatch

A list of CloudWatch dimensions upon which to categorize your emails.

Returns:



71
72
73
 
# File 'ses/event_destination.rb', line 71

def dimensions()
  jsii_get_property("dimensions")
end

#stream ⇒ AWSCDK::SES::FirehoseDeliveryStreamDestination?

Note:

Default: - do not send events to Firehose Delivery Stream

Use Firehose Delivery Stream.

Returns:



79
80
81
 
# File 'ses/event_destination.rb', line 79

def stream()
  jsii_get_property("stream")
end

#topic ⇒ AWSCDK::SNS::ITopic?

Note:

Default: - do not send events to a SNS topic

A SNS topic to use as event destination.

Returns:



87
88
89
 
# File 'ses/event_destination.rb', line 87

def topic()
  jsii_get_property("topic")
end