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.30.0 (build adae23f)",
           date="2021-06-30T10:01:43.944Z")
 @Stability(value=Experimental)
public interface SqsSendMessageProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

(experimental) Properties for sending a message to an SQS queue.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static SqsSendMessageProps.Builder	builder()
default Duration	getDelay() (experimental) The length of time, for which to delay a message.
TaskInput	getMessageBody() (experimental) The text message to send to the queue.
default String	getMessageDeduplicationId() (experimental) The token used for deduplication of sent messages.
default String	getMessageGroupId() (experimental) The tag that specifies that a message belongs to a specific message group.
IQueue	getQueue() (experimental) The SQS queue that messages will be sent to.

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

getComment, getHeartbeat, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMessageBody

@Stability(value=Experimental)
 @NotNull
TaskInput getMessageBody()

(experimental) The text message to send to the queue.

getQueue

@Stability(value=Experimental)
 @NotNull
IQueue getQueue()

(experimental) The SQS queue that messages will be sent to.

getDelay

@Stability(value=Experimental)
 @Nullable
default Duration getDelay()

(experimental) 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(value=Experimental)
 @Nullable
default String getMessageDeduplicationId()

(experimental) 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(value=Experimental)
 @Nullable
default String getMessageGroupId()

(experimental) 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(value=Experimental)
static SqsSendMessageProps.Builder builder()

Specified by:

builder in interface TaskStateBaseProps

Returns:

a SqsSendMessageProps.Builder of SqsSendMessageProps