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();
 
  • 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