software.amazon.awscdk.services.sqs

Interface DeadLetterQueue

All Known Implementing Classes:

DeadLetterQueue.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:52.290Z")
public interface DeadLetterQueue

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()
java.lang.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.

Method Detail

getMaxReceiveCount

java.lang.Number getMaxReceiveCount()

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

getQueue

IQueue getQueue()

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

builder

static DeadLetterQueue.Builder builder()

Returns:

a DeadLetterQueue.Builder of DeadLetterQueue