aws-cdk-lib.aws_stepfunctions_tasks.SqsSendMessageProps

SqsSendMessageProps Struct

Properties for sending a message to an SQS queue.

SqsSendMessageProps

extends

• TaskStateBaseProps

Source

aws-stepfunctions-tasks/lib/sqs/send-message.ts

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

assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= Not assign variables#

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

commentstringcommentstrcommentStringCommentstringComment*string= No comment#

A comment describing this state.

credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials= None (Task is executed using the…#

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

default

Default: None (Task is executed using the State Machine's execution role)

delayDurationdelayDurationdelayDurationDelayDurationDelayDuration= delay set on the queue. If a del…#

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

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

heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

inputPathstringinput_pathstrinputPathStringInputPathstringInputPath*string= $#

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 {}.

integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern= `IntegrationPattern.REQUEST_RESP…#

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.

default

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

messageBodyTaskInputmessage_bodyTaskInputmessageBodyTaskInputMessageBodyTaskInputMessageBodyTaskInputrequired#

The text message to send to the queue.

messageDeduplicationIdstringmessage_deduplication_idstrmessageDeduplicationIdStringMessageDeduplicationIdstringMessageDeduplicationId*string= 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.

messageGroupIdstringmessage_group_idstrmessageGroupIdStringMessageGroupIdstringMessageGroupId*string= 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.

outputPathstringoutput_pathstroutputPathStringOutputPathstringOutputPath*string= $#

JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

outputsanyoutputsAnyoutputsObjectOutputsobjectOutputsinterface{}= $states.result or $states.errorO…#

Used to specify and transform output from the state.

notes · default

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: $states.result or $states.errorOutput

queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= JSONPath#

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

queueIQueuequeueIQueuequeueIQueueQueueIQueueQueueIQueuerequired#

The SQS queue that messages will be sent to.

resultPathstringresult_pathstrresultPathStringResultPathstringResultPath*string= $#

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{ [key: string]: any }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= 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.

stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#

Optional name for this state.

default

Default: The construct ID will be used as state name

taskTimeoutTimeouttask_timeoutTimeouttaskTimeoutTimeoutTaskTimeoutTimeoutTaskTimeoutTimeout= None#

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Nonedeprecated#

use `taskTimeout`

Used as props by

• SqsSendMessage