Package software.amazon.awscdk.services.scheduler.targets.alpha

Interface SqsSendMessageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, ScheduleTargetBaseProps

All Known Implementing Classes:

SqsSendMessageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:09.717Z")
@Stability(Experimental)
public interface SqsSendMessageProps
extends software.amazon.jsii.JsiiSerializable, ScheduleTargetBaseProps

(experimental) Properties for a SQS Queue Target.

Example:

 String payload = "test";
 String messageGroupId = "id";
 Queue queue = Queue.Builder.create(this, "MyQueue")
         .fifo(true)
         .contentBasedDeduplication(true)
         .build();
 SqsSendMessage target = SqsSendMessage.Builder.create(queue)
         .input(ScheduleTargetInput.fromText(payload))
         .messageGroupId(messageGroupId)
         .build();
 Schedule.Builder.create(this, "Schedule")
         .schedule(ScheduleExpression.rate(Duration.minutes(1)))
         .target(target)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SqsSendMessageProps.Builder	builder()
default String	getMessageGroupId()	(experimental) The FIFO message group ID to use as the target.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.scheduler.targets.alpha.ScheduleTargetBaseProps

getDeadLetterQueue, getInput, getMaxEventAge, getRetryAttempts, getRole

Method Details

getMessageGroupId

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

(experimental) The FIFO message group ID to use as the target.

This must be specified when the target is a FIFO queue. If you specify a FIFO queue as a target, the queue must have content-based deduplication enabled.

A length of messageGroupId must be between 1 and 128.

Default: - no message group ID

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-scheduler-schedule-sqsparameters.html#cfn-scheduler-schedule-sqsparameters-messagegroupid

builder

@Stability(Experimental)
static SqsSendMessageProps.Builder builder()

Returns:

a SqsSendMessageProps.Builder of SqsSendMessageProps