Package software.amazon.awscdk.services.sqs

Class DeadLetterQueue.Builder

java.lang.Object

software.amazon.awscdk.services.sqs.DeadLetterQueue.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<DeadLetterQueue>

Enclosing interface:

DeadLetterQueue

@Stability(Stable)
public static final class DeadLetterQueue.Builder
extends Object
implements software.amazon.jsii.Builder<DeadLetterQueue>

A builder for DeadLetterQueue

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DeadLetterQueue	build()	Builds the configured instance.
DeadLetterQueue.Builder	maxReceiveCount(Number maxReceiveCount)	Sets the value of DeadLetterQueue.getMaxReceiveCount()
DeadLetterQueue.Builder	queue(IQueue queue)	Sets the value of DeadLetterQueue.getQueue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

maxReceiveCount

@Stability(Stable)
public DeadLetterQueue.Builder maxReceiveCount(Number maxReceiveCount)

Sets the value of DeadLetterQueue.getMaxReceiveCount()

Parameters:

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

Returns:

this

queue

@Stability(Stable)
public DeadLetterQueue.Builder queue(IQueue queue)

Sets the value of DeadLetterQueue.getQueue()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public DeadLetterQueue build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<DeadLetterQueue>

Returns:

a new instance of DeadLetterQueue

Throws:

NullPointerException - if any required attribute was not provided