Interface SqsQueueProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
,TargetBaseProps
- All Known Implementing Classes:
SqsQueueProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:19.401Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forSqsQueueProps
static final class
An implementation forSqsQueueProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic SqsQueueProps.Builder
builder()
default RuleTargetInput
The message to send to the queue.default String
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
The message to send to the queue.Must be a valid JSON text passed to the target queue.
Default: the entire EventBridge event
-
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
- Returns:
- a
SqsQueueProps.Builder
ofSqsQueueProps
-