Class: AWSCDK::EventsTargets::EventBusProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
events_targets/event_bus_props.rb

Overview

Configuration properties of an Event Bus event.

Cannot extend TargetBaseProps. Retry policy is not supported for Event bus targets.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dead_letter_queue: nil, role: nil) ⇒ EventBusProps

Returns a new instance of EventBusProps.

Parameters:



11
12
13
14
15
16
 
# File 'events_targets/event_bus_props.rb', line 11

def initialize(dead_letter_queue: nil, role: nil)
  @dead_letter_queue = dead_letter_queue
  Jsii::Type.check_type(@dead_letter_queue, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLklRdWV1ZSJ9")), "deadLetterQueue") unless @dead_letter_queue.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
end

Instance Attribute Details

#dead_letter_queue ⇒ AWSCDK::SQS::IQueue? (readonly)

Note:

Default: - no dead-letter queue

The SQS queue to be used as deadLetterQueue. Check out the considerations for using a dead-letter queue.

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Returns:



26
27
28
 
# File 'events_targets/event_bus_props.rb', line 26

def dead_letter_queue
  @dead_letter_queue
end

#role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: a new role is created.

Role to be used to publish the event.

Returns:



31
32
33
 
# File 'events_targets/event_bus_props.rb', line 31

def role
  @role
end

Class Method Details

.jsii_properties ⇒ Object 



33
34
35
36
37
38
 
# File 'events_targets/event_bus_props.rb', line 33

def self.jsii_properties
  {
    :dead_letter_queue => "deadLetterQueue",
    :role => "role",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'events_targets/event_bus_props.rb', line 40

def to_jsii
  result = {}
  result.merge!({
    "deadLetterQueue" => @dead_letter_queue,
    "role" => @role,
  })
  result.compact
end