Class: AWSCDK::SQS::DeadLetterQueue

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
sqs/dead_letter_queue.rb

Overview

Dead letter queue settings.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(max_receive_count:, queue:) ⇒ DeadLetterQueue

Returns a new instance of DeadLetterQueue.

Parameters:

  • max_receive_count (Numeric) —

    The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.

  • queue (AWSCDK::SQS::IQueue) —

    The dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.



9
10
11
12
13
14
 
# File 'sqs/dead_letter_queue.rb', line 9

def initialize(max_receive_count:, queue:)
  @max_receive_count = max_receive_count
  Jsii::Type.check_type(@max_receive_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxReceiveCount")
  @queue = queue
  Jsii::Type.check_type(@queue, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3FzLklRdWV1ZSJ9")), "queue")
end

Instance Attribute Details

#max_receive_count ⇒ Numeric (readonly)

The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.

Returns:

  • (Numeric) 


19
20
21
 
# File 'sqs/dead_letter_queue.rb', line 19

def max_receive_count
  @max_receive_count
end

#queue ⇒ AWSCDK::SQS::IQueue (readonly)

The dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

Returns:



23
24
25
 
# File 'sqs/dead_letter_queue.rb', line 23

def queue
  @queue
end

Class Method Details

.jsii_properties ⇒ Object 



25
26
27
28
29
30
 
# File 'sqs/dead_letter_queue.rb', line 25

def self.jsii_properties
  {
    :max_receive_count => "maxReceiveCount",
    :queue => "queue",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



32
33
34
35
36
37
38
39
 
# File 'sqs/dead_letter_queue.rb', line 32

def to_jsii
  result = {}
  result.merge!({
    "maxReceiveCount" => @max_receive_count,
    "queue" => @queue,
  })
  result.compact
end