Class SqsSendMessage

A StepFunctions Task to send messages to SQS queue.

Inheritance
object
State
TaskStateBase
SqsSendMessage
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SqsSendMessage : TaskStateBase, IChainable, INextable
Syntax (vb)
Public Class SqsSendMessage Inherits TaskStateBase Implements IChainable, INextable
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

Constructors

SqsSendMessage(Construct, string, ISqsSendMessageProps)

A StepFunctions Task to send messages to SQS queue.

Properties

TaskMetrics

A StepFunctions Task to send messages to SQS queue.
TaskPolicies

A StepFunctions Task to send messages to SQS queue.

Methods

JsonPath(Construct, string, ISqsSendMessageJsonPathProps)

A StepFunctions Task to send messages to SQS queue using JSONPath.
Jsonata(Construct, string, ISqsSendMessageJsonataProps)

A StepFunctions Task to send messages to SQS queue using JSONata.

Constructors

SqsSendMessage(Construct, string, ISqsSendMessageProps)

A StepFunctions Task to send messages to SQS queue.

public SqsSendMessage(Construct scope, string id, ISqsSendMessageProps props)
Parameters
scope Construct
id string

Descriptive identifier for this chainable.

props ISqsSendMessageProps
Remarks

ExampleMetadata: infused

Properties

TaskMetrics

A StepFunctions Task to send messages to SQS queue.

protected override ITaskMetricsConfig? TaskMetrics { get; }
Property Value

ITaskMetricsConfig

Overrides
Remarks

ExampleMetadata: infused

TaskPolicies

A StepFunctions Task to send messages to SQS queue.

protected override PolicyStatement[]? TaskPolicies { get; }
Property Value

PolicyStatement[]

Overrides
Remarks

ExampleMetadata: infused

Methods

JsonPath(Construct, string, ISqsSendMessageJsonPathProps)

A StepFunctions Task to send messages to SQS queue using JSONPath.

public static SqsSendMessage JsonPath(Construct scope, string id, ISqsSendMessageJsonPathProps props)
Parameters
scope Construct
id string
props ISqsSendMessageJsonPathProps
Returns

SqsSendMessage

Remarks

ExampleMetadata: infused

Jsonata(Construct, string, ISqsSendMessageJsonataProps)

A StepFunctions Task to send messages to SQS queue using JSONata.

public static SqsSendMessage Jsonata(Construct scope, string id, ISqsSendMessageJsonataProps props)
Parameters
scope Construct
id string
props ISqsSendMessageJsonataProps
Returns

SqsSendMessage

Remarks

ExampleMetadata: infused

Implements