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=Experimental)
public static final class SqsQueue.Builder
extends Object
implements software.amazon.jsii.Builder<SqsQueue>

(experimental) A fluent builder for SqsQueue.

Method Summary

Modifier and Type	Method and Description
SqsQueue	build()
static SqsQueue.Builder	create(IQueue queue)
SqsQueue.Builder	message(RuleTargetInput message) (experimental) The message to send to the queue.
SqsQueue.Builder	messageGroupId(String messageGroupId) (experimental) Message Group ID for messages sent to this queue.

Methods inherited from class java.lang.Object

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

Method Detail

create

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

Parameters:

queue - This parameter is required.

Returns:

a new instance of SqsQueue.Builder.

message

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

(experimental) 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=Experimental)
public SqsQueue.Builder messageGroupId(String messageGroupId)

(experimental) 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=Experimental)
public SqsQueue build()

Specified by:

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