software.amazon.awscdk.services.events.targets

Class SqsQueue.Builder

java.lang.Object

software.amazon.awscdk.services.events.targets.SqsQueue.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SqsQueue>

Enclosing class:

SqsQueue

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

A fluent builder for SqsQueue.

Method Summary

Modifier and Type	Method and Description
SqsQueue	build()
static SqsQueue.Builder	create(IQueue queue)
SqsQueue.Builder	deadLetterQueue(IQueue deadLetterQueue) The SQS queue to be used as deadLetterQueue.
SqsQueue.Builder	maxEventAge(Duration maxEventAge) The maximum age of a request that Lambda sends to a function for processing.
SqsQueue.Builder	message(RuleTargetInput message) The message to send to the queue.
SqsQueue.Builder	messageGroupId(String messageGroupId) Message Group ID for messages sent to this queue.
SqsQueue.Builder	retryAttempts(Number retryAttempts) The maximum number of times to retry when the function returns an error.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static SqsQueue.Builder create(IQueue queue)

Parameters:

queue - This parameter is required.

Returns:

a new instance of SqsQueue.Builder.

deadLetterQueue

@Stability(value=Stable)
public SqsQueue.Builder deadLetterQueue(IQueue deadLetterQueue)

The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations).

The events not successfully delivered are automatically retried for a specified period of time, depending on the retry policy of the target. If an event is not delivered before all retry attempts are exhausted, it will be sent to the dead letter queue.

Default: - no dead-letter queue

Parameters:

deadLetterQueue - The SQS queue to be used as deadLetterQueue. Check out the [considerations for using a dead-letter queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/rule-dlq.html#dlq-considerations). This parameter is required.

Returns:

this

maxEventAge

@Stability(value=Stable)
public SqsQueue.Builder maxEventAge(Duration maxEventAge)

The maximum age of a request that Lambda sends to a function for processing.

Minimum value of 60. Maximum value of 86400.

Default: Duration.hours(24)

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. This parameter is required.

Returns:

this

retryAttempts

@Stability(value=Stable)
public SqsQueue.Builder retryAttempts(Number retryAttempts)

The maximum number of times to retry when the function returns an error.

Minimum value of 0. Maximum value of 185.

Default: 185

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. This parameter is required.

Returns:

this

message

@Stability(value=Stable)
public SqsQueue.Builder message(RuleTargetInput message)

The message to send to the queue.

Must be a valid JSON text passed to the target queue.

Default: the entire EventBridge event

Parameters:

message - The message to send to the queue. This parameter is required.

Returns:

this

messageGroupId

@Stability(value=Stable)
public SqsQueue.Builder messageGroupId(String messageGroupId)

Message Group ID for messages sent to this queue.

Required for FIFO queues, leave empty for regular queues.

Default: - no message group ID (regular queue)

Parameters:

messageGroupId - Message Group ID for messages sent to this queue. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public SqsQueue build()

Specified by:

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