Package software.amazon.awscdk.services.events.targets

Interface SqsQueueProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TargetBaseProps

All Known Implementing Classes:

SqsQueueProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-19T12:03:54.845Z")
@Stability(Stable)
public interface SqsQueueProps
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Customize the SQS Queue Event Target.

Example:

 // FIFO queue - messageGroupId required
 Queue fifoQueue = Queue.Builder.create(this, "MyFifoQueue")
         .fifo(true)
         .build();
 Rule fifoRule = Rule.Builder.create(this, "FifoRule")
         .schedule(Schedule.rate(Duration.hours(1)))
         .build();
 fifoRule.addTarget(SqsQueue.Builder.create(fifoQueue)
         .messageGroupId("MyMessageGroupId")
         .build());
 // Standard queue - messageGroupId optional (SQS Fair queue feature)
 Queue standardQueue = new Queue(this, "MyStandardQueue");
 Rule standardRule = Rule.Builder.create(this, "StandardRule")
         .schedule(Schedule.rate(Duration.hours(1)))
         .build();
 standardRule.addTarget(SqsQueue.Builder.create(standardQueue)
         .messageGroupId("MyMessageGroupId")
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	SqsQueueProps.Builder	A builder for SqsQueueProps
static final class	SqsQueueProps.Jsii$Proxy	An implementation for SqsQueueProps

Method Summary

Modifier and Type	Method	Description
static SqsQueueProps.Builder	builder()
default RuleTargetInput	getMessage()	The message to send to the queue.
default String	getMessageGroupId()	Message Group ID for messages sent to this queue.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.events.targets.TargetBaseProps

getDeadLetterQueue, getMaxEventAge, getRetryAttempts

Method Details

getMessage

@Stability(Stable)
@Nullable
default RuleTargetInput getMessage()

The message to send to the queue.

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

Default: the entire EventBridge event

getMessageGroupId

@Stability(Stable)
@Nullable
default String getMessageGroupId()

Message Group ID for messages sent to this queue.

Required for FIFO queues. For standard queues, this parameter is optional and can be used for SQS fair queue feature and deduplication.

Default: - no message group ID

builder

@Stability(Stable)
static SqsQueueProps.Builder builder()

Returns:

a SqsQueueProps.Builder of SqsQueueProps