Package software.amazon.awscdk.services.stepfunctions.tasks

Interface SqsSendMessageProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

SqsSendMessageProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:10.444Z")
@Stability(Stable)
public interface SqsSendMessageProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for sending a message to an SQS queue.

Example:

 Queue queue = new Queue(this, "Queue");
 // Use a field from the execution data as message.
 SqsSendMessage task1 = SqsSendMessage.Builder.create(this, "Send1")
         .queue(queue)
         .messageBody(TaskInput.fromJsonPathAt("$.message"))
         .build();
 // Combine a field from the execution data with
 // a literal object.
 SqsSendMessage task2 = SqsSendMessage.Builder.create(this, "Send2")
         .queue(queue)
         .messageBody(TaskInput.fromObject(Map.of(
                 "field1", "somedata",
                 "field2", JsonPath.stringAt("$.field2"))))
         .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 Duration	getDelay()	The length of time, for which to delay a message.
TaskInput	getMessageBody()	The text message to send to the queue.
default String	getMessageDeduplicationId()	The token used for deduplication of sent messages.
default String	getMessageGroupId()	The tag that specifies that a message belongs to a specific message group.
IQueue	getQueue()	The SQS queue that messages will be sent to.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getMessageBody

@Stability(Stable)
@NotNull
TaskInput getMessageBody()

The text message to send to the queue.

getQueue

@Stability(Stable)
@NotNull
IQueue getQueue()

The SQS queue that messages will be sent to.

getDelay

@Stability(Stable)
@Nullable
default Duration getDelay()

The length of time, for which to delay a message.

Messages that you send to the queue remain invisible to consumers for the duration of the delay period. The maximum allowed delay is 15 minutes.

Default: - delay set on the queue. If a delay is not set on the queue, messages are sent immediately (0 seconds).

getMessageDeduplicationId

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

The token used for deduplication of sent messages.

Any messages sent with the same deduplication ID are accepted successfully, but aren't delivered during the 5-minute deduplication interval.

Default: - None

getMessageGroupId

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

The tag that specifies that a message belongs to a specific message group.

Messages that belong to the same message group are processed in a FIFO manner. Messages in different message groups might be processed out of order.

Default: - None

builder

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

Returns:

a SqsSendMessageProps.Builder of SqsSendMessageProps