Skip to content
v2.278.0

SqsSendMessageJsonPathProps Struct ​

Properties for sending a message to an SQS queue using JSONPath.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_sqs as sqs } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
import { aws_stepfunctions_tasks as stepfunctions_tasks } from 'aws-cdk-lib';

declare const assign: any;
declare const queue: sqs.Queue;
declare const resultSelector: any;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const sqsSendMessageJsonPathProps: stepfunctions_tasks.SqsSendMessageJsonPathProps = {
  messageBody: taskInput,
  queue: queue,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  delay: cdk.Duration.minutes(30),
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  messageDeduplicationId: 'messageDeduplicationId',
  messageGroupId: 'messageGroupId',
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_sqs as sqs
from aws_cdk import aws_stepfunctions as stepfunctions
from aws_cdk import aws_stepfunctions_tasks as stepfunctions_tasks

# assign: Any
# queue: sqs.Queue
# result_selector: Any
# task_input: stepfunctions.TaskInput
# task_role: stepfunctions.TaskRole
# timeout: stepfunctions.Timeout

sqs_send_message_json_path_props = stepfunctions_tasks.SqsSendMessageJsonPathProps(
    message_body=task_input,
    queue=queue,

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    credentials=stepfunctions.Credentials(
        role=task_role
    ),
    delay=cdk.Duration.minutes(30),
    heartbeat=cdk.Duration.minutes(30),
    heartbeat_timeout=timeout,
    input_path="inputPath",
    integration_pattern=stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
    message_deduplication_id="messageDeduplicationId",
    message_group_id="messageGroupId",
    output_path="outputPath",
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    state_name="stateName",
    task_timeout=timeout,
    timeout=cdk.Duration.minutes(30)
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.sqs.*;
import software.amazon.awscdk.services.stepfunctions.*;
import software.amazon.awscdk.services.stepfunctions.tasks.*;

Object assign;
Queue queue;
Object resultSelector;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;

SqsSendMessageJsonPathProps sqsSendMessageJsonPathProps = SqsSendMessageJsonPathProps.builder()
        .messageBody(taskInput)
        .queue(queue)

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .credentials(Credentials.builder()
                .role(taskRole)
                .build())
        .delay(Duration.minutes(30))
        .heartbeat(Duration.minutes(30))
        .heartbeatTimeout(timeout)
        .inputPath("inputPath")
        .integrationPattern(IntegrationPattern.REQUEST_RESPONSE)
        .messageDeduplicationId("messageDeduplicationId")
        .messageGroupId("messageGroupId")
        .outputPath("outputPath")
        .queryLanguage(QueryLanguage.JSON_PATH)
        .resultPath("resultPath")
        .resultSelector(Map.of(
                "resultSelectorKey", resultSelector))
        .stateName("stateName")
        .taskTimeout(timeout)
        .timeout(Duration.minutes(30))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.SQS;
using Amazon.CDK.AWS.StepFunctions;
using Amazon.CDK.AWS.StepFunctions.Tasks;

var assign;
Queue queue;
var resultSelector;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;

var sqsSendMessageJsonPathProps = new SqsSendMessageJsonPathProps {
    MessageBody = taskInput,
    Queue = queue,

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    Credentials = new Credentials {
        Role = taskRole
    },
    Delay = Duration.Minutes(30),
    Heartbeat = Duration.Minutes(30),
    HeartbeatTimeout = timeout,
    InputPath = "inputPath",
    IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
    MessageDeduplicationId = "messageDeduplicationId",
    MessageGroupId = "messageGroupId",
    OutputPath = "outputPath",
    QueryLanguage = QueryLanguage.JSON_PATH,
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    StateName = "stateName",
    TaskTimeout = timeout,
    Timeout = Duration.Minutes(30)
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var assign interface{}
var queue Queue
var resultSelector interface{}
var taskInput TaskInput
var taskRole TaskRole
var timeout Timeout

sqsSendMessageJsonPathProps := &SqsSendMessageJsonPathProps{
	MessageBody: taskInput,
	Queue: queue,

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	Credentials: &Credentials{
		Role: taskRole,
	},
	Delay: cdk.Duration_Minutes(jsii.Number(30)),
	Heartbeat: cdk.Duration_*Minutes(jsii.Number(30)),
	HeartbeatTimeout: timeout,
	InputPath: jsii.String("inputPath"),
	IntegrationPattern: awscdk.Aws_stepfunctions.IntegrationPattern_REQUEST_RESPONSE,
	MessageDeduplicationId: jsii.String("messageDeduplicationId"),
	MessageGroupId: jsii.String("messageGroupId"),
	OutputPath: jsii.String("outputPath"),
	QueryLanguage: awscdk.*Aws_stepfunctions.QueryLanguage_JSON_PATH,
	ResultPath: jsii.String("resultPath"),
	ResultSelector: map[string]interface{}{
		"resultSelectorKey": resultSelector,
	},
	StateName: jsii.String("stateName"),
	TaskTimeout: timeout,
	Timeout: cdk.Duration_*Minutes(jsii.Number(30)),
}

Properties ​

assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{} #
Workflow variables to store in this step.

Default: Not assign variables

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

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #
A comment describing this state.

Default: No comment

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

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

This enables cross-account resource invocations.

delayoptionalDurationdelayoptionalDurationdelayoptionalDurationDelayoptionalDurationDelayoptionalDuration #
The length of time, for which to delay a message.

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

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.

heartbeatoptionalDurationheartbeatoptionalDurationheartbeatoptionalDurationHeartbeatoptionalDurationHeartbeatoptionalDuration = None deprecated #
use `heartbeatTimeout`
heartbeatTimeoutoptionalTimeoutheartbeat_timeoutoptionalTimeoutheartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeoutHeartbeatTimeoutoptionalTimeout = None #
Timeout for the heartbeat.

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

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

integrationPatternoptionalIntegrationPatternintegration_patternoptionalIntegrationPatternintegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPatternIntegrationPatternoptionalIntegrationPattern #
AWS Step Functions integrates with services directly in the Amazon States Language.

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

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

messageBodyTaskInputmessage_bodyTaskInputmessageBodyTaskInputMessageBodyTaskInputMessageBodyTaskInput required #
The text message to send to the queue.
messageDeduplicationIdoptionalstringmessage_deduplication_idoptionalstrmessageDeduplicationIdoptionalStringMessageDeduplicationIdoptionalstringMessageDeduplicationIdoptional*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.

messageGroupIdoptionalstringmessage_group_idoptionalstrmessageGroupIdoptionalStringMessageGroupIdoptionalstringMessageGroupIdoptional*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.

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

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage = 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.

queueIQueuequeueIQueuequeueIQueueQueueIQueueQueueIQueue required #
The SQS queue that messages will be sent to.
resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*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.

resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*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.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string #
Optional name for this state.

Default: The construct ID will be used as state name

taskTimeoutoptionalTimeouttask_timeoutoptionalTimeouttaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeoutTaskTimeoutoptionalTimeout = None #
Timeout for the task.

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

timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration = None deprecated #
use `taskTimeout`