interface SqsSendMessageProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.Tasks.SqsSendMessageProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctionstasks#SqsSendMessageProps |
Java | software.amazon.awscdk.services.stepfunctions.tasks.SqsSendMessageProps |
Python | aws_cdk.aws_stepfunctions_tasks.SqsSendMessageProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions_tasks » SqsSendMessageProps |
Properties for sending a message to an SQS queue.
Example
const queue = new sqs.Queue(this, 'Queue');
// Use a field from the execution data as message.
const task1 = new tasks.SqsSendMessage(this, 'Send1', {
queue,
messageBody: sfn.TaskInput.fromJsonPathAt('$.message'),
});
// Combine a field from the execution data with
// a literal object.
const task2 = new tasks.SqsSendMessage(this, 'Send2', {
queue,
messageBody: sfn.TaskInput.fromObject({
field1: 'somedata',
field2: sfn.JsonPath.stringAt('$.field2'),
}),
});
Properties
Name | Type | Description |
---|---|---|
message | Task | The text message to send to the queue. |
queue | IQueue | The SQS queue that messages will be sent to. |
comment? | string | An optional description for this state. |
credentials? | Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
delay? | Duration | The length of time, for which to delay a message. |
heartbeat? | Duration | Timeout for the heartbeat. |
heartbeat | Timeout | Timeout for the heartbeat. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
integration | Integration | AWS Step Functions integrates with services directly in the Amazon States Language. |
message | string | The token used for deduplication of sent messages. |
message | string | The tag that specifies that a message belongs to a specific message group. |
output | string | JSONPath expression to select select a portion of the state output to pass to the next state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | Optional name for this state. |
task | Timeout | Timeout for the task. |
timeout? | Duration | Timeout for the task. |
messageBody
Type:
Task
The text message to send to the queue.
queue
Type:
IQueue
The SQS queue that messages will be sent to.
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
credentials?
Type:
Credentials
(optional, default: None (Task is executed using the State Machine's execution role))
Credentials for an IAM Role that the State Machine assumes for executing the task.
This enables cross-account resource invocations.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
delay?
Type:
Duration
(optional, default: delay set on the queue. If a delay is not set on the queue,
messages are sent immediately (0 seconds).)
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.
heartbeat?
⚠️ Deprecated: use heartbeatTimeout
Type:
Duration
(optional, default: None)
Timeout for the heartbeat.
heartbeatTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the heartbeat.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
inputPath?
Type:
string
(optional, default: The entire task input (JSON path '$'))
JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
integrationPattern?
Type:
Integration
(optional, default: IntegrationPattern.REQUEST_RESPONSE
for most tasks.
IntegrationPattern.RUN_JOB
for the following exceptions:
BatchSubmitJob
, EmrAddStep
, EmrCreateCluster
, EmrTerminationCluster
, and EmrContainersStartJobRun
.)
AWS Step Functions integrates with services directly in the Amazon States Language.
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
messageDeduplicationId?
Type:
string
(optional, default: None)
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.
messageGroupId?
Type:
string
(optional, default: None)
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.
outputPath?
Type:
string
(optional, default: The entire JSON node determined by the state input, the task result,
and resultPath is passed to the next state (JSON path '$'))
JSONPath expression to select select a portion of the state output to pass to the next state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
resultPath?
Type:
string
(optional, default: Replaces the entire input with the result (JSON path '$'))
JSONPath expression to indicate where to inject the state's output.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
resultSelector?
Type:
{ [string]: any }
(optional, default: None)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
taskTimeout?
Type:
Timeout
(optional, default: None)
Timeout for the task.
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
timeout?
⚠️ Deprecated: use taskTimeout
Type:
Duration
(optional, default: None)
Timeout for the task.