Class: AWSCDK::EventsTargets::TargetBaseProps

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

Overview

The generic properties for an RuleTarget.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dead_letter_queue: nil, max_event_age: nil, retry_attempts: nil) ⇒ TargetBaseProps

Returns a new instance of TargetBaseProps.

Parameters:

  • dead_letter_queue (AWSCDK::SQS::IQueue, nil) (defaults to: nil) —

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

  • max_event_age (AWSCDK::Duration, nil) (defaults to: nil) —

    The maximum age of a request that Lambda sends to a function for processing.

  • retry_attempts (Numeric, nil) (defaults to: nil) —

    The maximum number of times to retry when the function returns an error.



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

def initialize(dead_letter_queue: nil, max_event_age: nil, retry_attempts: 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?
  @max_event_age = max_event_age
  Jsii::Type.check_type(@max_event_age, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "maxEventAge") unless @max_event_age.nil?
  @retry_attempts = retry_attempts
  Jsii::Type.check_type(@retry_attempts, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "retryAttempts") unless @retry_attempts.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:



27
28
29
 
# File 'events_targets/target_base_props.rb', line 27

def dead_letter_queue
  @dead_letter_queue
end

#max_event_age ⇒ AWSCDK::Duration? (readonly)

Note:

Default: Duration.hours(24)

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Returns:



35
36
37
 
# File 'events_targets/target_base_props.rb', line 35

def max_event_age
  @max_event_age
end

#retry_attempts ⇒ Numeric? (readonly)

Note:

Default: 185

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Returns:

  • (Numeric, nil) 


43
44
45
 
# File 'events_targets/target_base_props.rb', line 43

def retry_attempts
  @retry_attempts
end

Class Method Details

.jsii_properties ⇒ Object 



45
46
47
48
49
50
51
 
# File 'events_targets/target_base_props.rb', line 45

def self.jsii_properties
  {
    :dead_letter_queue => "deadLetterQueue",
    :max_event_age => "maxEventAge",
    :retry_attempts => "retryAttempts",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



53
54
55
56
57
58
59
60
61
 
# File 'events_targets/target_base_props.rb', line 53

def to_jsii
  result = {}
  result.merge!({
    "deadLetterQueue" => @dead_letter_queue,
    "maxEventAge" => @max_event_age,
    "retryAttempts" => @retry_attempts,
  })
  result.compact
end