Interface ISqsSendMessageProps
Properties for sending a message to an SQS queue.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.AWS.StepFunctions.Tasks.dll
Syntax (csharp)
public interface ISqsSendMessageProps : ITaskStateBaseProps
Syntax (vb)
Public Interface ISqsSendMessageProps
Inherits ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
var queue = new Queue(this, "Queue");
// Use a field from the execution data as message.
var task1 = new SqsSendMessage(this, "Send1", new SqsSendMessageProps {
Queue = queue,
MessageBody = TaskInput.FromJsonPathAt("$.message")
});
// Combine a field from the execution data with
// a literal object.
var task2 = new SqsSendMessage(this, "Send2", new SqsSendMessageProps {
Queue = queue,
MessageBody = TaskInput.FromObject(new Dictionary<string, object> {
{ "field1", "somedata" },
{ "field2", JsonPath.StringAt("$.field2") }
})
});
Synopsis
Properties
Delay | The length of time, for which to delay a message. |
MessageBody | The text message to send to the queue. |
MessageDeduplicationId | The token used for deduplication of sent messages. |
MessageGroupId | The tag that specifies that a message belongs to a specific message group. |
Queue | The SQS queue that messages will be sent to. |
Properties
Delay
The length of time, for which to delay a message.
virtual Duration Delay { get; }
Property Value
Remarks
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).
MessageBody
MessageDeduplicationId
The token used for deduplication of sent messages.
virtual string MessageDeduplicationId { get; }
Property Value
System.String
Remarks
Any messages sent with the same deduplication ID are accepted successfully, but aren't delivered during the 5-minute deduplication interval.
Default: - None
MessageGroupId
The tag that specifies that a message belongs to a specific message group.
virtual string MessageGroupId { get; }
Property Value
System.String
Remarks
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