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.119.0 (build 1634eac)",
           date="2025-12-01T16:02:21.284Z")
@Stability(Stable)
public interface SqsQueueProps
extends software.amazon.jsii.JsiiSerializable, TargetBaseProps

Customize the SQS Queue Event Target.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.events.*;
 import software.amazon.awscdk.services.events.targets.*;
 import software.amazon.awscdk.services.sqs.*;
 Queue queue;
 RuleTargetInput ruleTargetInput;
 SqsQueueProps sqsQueueProps = SqsQueueProps.builder()
         .deadLetterQueue(queue)
         .maxEventAge(Duration.minutes(30))
         .message(ruleTargetInput)
         .messageGroupId("messageGroupId")
         .retryAttempts(123)
         .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, leave empty for regular queues.

Default: - no message group ID (regular queue)

builder

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

Returns:

a SqsQueueProps.Builder of SqsQueueProps