Package software.amazon.awscdk.services.sqs

Interface DeadLetterQueue

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

DeadLetterQueue.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:49.126Z")
@Stability(Stable)
public interface DeadLetterQueue
extends software.amazon.jsii.JsiiSerializable

Dead letter queue settings.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 DeadLetterQueue deadLetterQueue = DeadLetterQueue.builder()
         .maxReceiveCount(123)
         .queue(queue)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DeadLetterQueue.Builder	A builder for DeadLetterQueue
static final class	DeadLetterQueue.Jsii$Proxy	An implementation for DeadLetterQueue

Method Summary

Modifier and Type	Method	Description
static DeadLetterQueue.Builder	builder()
Number	getMaxReceiveCount()	The number of times a message can be unsuccessfully dequeued before being moved to the dead-letter queue.
IQueue	getQueue()	The dead-letter queue to which Amazon SQS moves messages after the value of maxReceiveCount is exceeded.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxReceiveCount

@Stability(Stable)
@NotNull
Number getMaxReceiveCount()

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

getQueue

@Stability(Stable)
@NotNull
IQueue getQueue()

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

builder

@Stability(Stable)
static DeadLetterQueue.Builder builder()

Returns:

a DeadLetterQueue.Builder of DeadLetterQueue