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.74.0 (build 6d08790)",
           date="2023-05-19T23:09:25.069Z")
 @Stability(value=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 and Description
static class	DeadLetterQueue.Builder A builder for DeadLetterQueue
static class	DeadLetterQueue.Jsii$Proxy An implementation for DeadLetterQueue

Method Summary

Modifier and Type	Method and Description
static DeadLetterQueue.Builder	builder()
Number	getMaxReceiveCount() The number of times a message can be unsuccesfully 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 Detail

getMaxReceiveCount

@Stability(value=Stable)
 @NotNull
Number getMaxReceiveCount()

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

getQueue

@Stability(value=Stable)
 @NotNull
IQueue getQueue()

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

builder

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

Returns:

a DeadLetterQueue.Builder of DeadLetterQueue