software.amazon.awscdk.services.events.targets

Class SqsQueueProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SqsQueueProps>

Enclosing interface:

SqsQueueProps

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

A builder for SqsQueueProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SqsQueueProps	build() Builds the configured instance.
SqsQueueProps.Builder	deadLetterQueue(IQueue deadLetterQueue) Sets the value of TargetBaseProps.getDeadLetterQueue()
SqsQueueProps.Builder	maxEventAge(Duration maxEventAge) Sets the value of TargetBaseProps.getMaxEventAge()
SqsQueueProps.Builder	message(RuleTargetInput message) Sets the value of SqsQueueProps.getMessage()
SqsQueueProps.Builder	messageGroupId(String messageGroupId) Sets the value of SqsQueueProps.getMessageGroupId()
SqsQueueProps.Builder	retryAttempts(Number retryAttempts) Sets the value of TargetBaseProps.getRetryAttempts()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

message

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

Sets the value of SqsQueueProps.getMessage()

Parameters:

message - The message to send to the queue. Must be a valid JSON text passed to the target queue.

Returns:

this

messageGroupId

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

Sets the value of SqsQueueProps.getMessageGroupId()

Parameters:

messageGroupId - Message Group ID for messages sent to this queue. Required for FIFO queues, leave empty for regular queues.

Returns:

this

deadLetterQueue

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

Sets the value of TargetBaseProps.getDeadLetterQueue()

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). 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.

Returns:

this

maxEventAge

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

Sets the value of TargetBaseProps.getMaxEventAge()

Parameters:

maxEventAge - The maximum age of a request that Lambda sends to a function for processing. Minimum value of 60. Maximum value of 86400.

Returns:

this

retryAttempts

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

Sets the value of TargetBaseProps.getRetryAttempts()

Parameters:

retryAttempts - The maximum number of times to retry when the function returns an error. Minimum value of 0. Maximum value of 185.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SqsQueueProps

Throws:

NullPointerException - if any required attribute was not provided