Class SqsSendMessageJsonataProps
Properties for sending a message to an SQS queue using JSONata.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SqsSendMessageJsonataProps : Object, ISqsSendMessageJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsSyntax (vb)
Public Class SqsSendMessageJsonataProps
Inherits Object
Implements ISqsSendMessageJsonataProps, ITaskStateJsonataBaseProps, IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonataCommonOptionsRemarks
ExampleMetadata: fixture=_generated
Examples
// 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;
var outputs;
Queue queue;
TaskInput taskInput;
TaskRole taskRole;
Timeout timeout;
var sqsSendMessageJsonataProps = new SqsSendMessageJsonataProps {
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,
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
MessageDeduplicationId = "messageDeduplicationId",
MessageGroupId = "messageGroupId",
Outputs = outputs,
QueryLanguage = QueryLanguage.JSON_PATH,
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30)
};Synopsis
Constructors
| Sqs |
Properties
| Assign | Workflow variables to store in this step. |
| Comment | A comment describing this state. |
| Credentials | Credentials for an IAM Role that the State Machine assumes for executing the task. |
| Delay | The length of time, for which to delay a message. |
| Heartbeat | (deprecated) Timeout for the heartbeat. |
| Heartbeat |
Timeout for the heartbeat. |
| Integration |
AWS Step Functions integrates with services directly in the Amazon States Language. |
| Message |
The text message to send to the queue. |
| Message |
The token used for deduplication of sent messages. |
| Message |
The tag that specifies that a message belongs to a specific message group. |
| Outputs | Used to specify and transform output from the state. |
| Query |
The name of the query language used by the state. |
| Queue | The SQS queue that messages will be sent to. |
| State |
Optional name for this state. |
| Task |
Timeout for the task. |
| Timeout | (deprecated) Timeout for the task. |
Constructors
SqsSendMessageJsonataProps()
public SqsSendMessageJsonataProps()Properties
Assign
Workflow variables to store in this step.
public IDictionary<string, object> Assign { get; set; }Property Value
System.
Remarks
Using workflow variables, you can store data in a step and retrieve that data in future steps.
Default: - Not assign variables
See: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html
Comment
A comment describing this state.
public string Comment { get; set; }Property Value
System.
Remarks
Default: No comment
Credentials
Credentials for an IAM Role that the State Machine assumes for executing the task.
public ICredentials Credentials { get; set; }Property Value
Remarks
This enables cross-account resource invocations.
Default: - None (Task is executed using the State Machine's execution role)
See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-access-cross-acct-resources.html
Delay
The length of time, for which to delay a message.
public Duration Delay { get; set; }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).
Heartbeat
(deprecated) Timeout for the heartbeat.
public Duration Heartbeat { get; set; }Property Value
Remarks
Default: - None
Stability: Deprecated
HeartbeatTimeout
Timeout for the heartbeat.
public Timeout HeartbeatTimeout { get; set; }Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
IntegrationPattern
AWS Step Functions integrates with services directly in the Amazon States Language.
public Nullable<IntegrationPattern> IntegrationPattern { get; set; }Property Value
System.
Remarks
You can control these AWS services using service integration patterns.
Depending on the AWS Service, the Service Integration Pattern availability will vary.
Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks.
IntegrationPattern.RUN_JOB for the following exceptions:
BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.
See: https://docs.aws.amazon.com/step-functions/latest/dg/connect-supported-services.html
MessageBody
The text message to send to the queue.
public TaskInput MessageBody { get; set; }Property Value
MessageDeduplicationId
The token used for deduplication of sent messages.
public string MessageDeduplicationId { get; set; }Property Value
System.
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.
public string MessageGroupId { get; set; }Property Value
System.
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
Outputs
Used to specify and transform output from the state.
public object Outputs { get; set; }Property Value
System.
Remarks
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
See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html
QueryLanguage
The name of the query language used by the state.
public Nullable<QueryLanguage> QueryLanguage { get; set; }Property Value
System.
Remarks
If the state does not contain a queryLanguage field,
then it will use the query language specified in the top-level queryLanguage field.
Default: - JSONPath
Queue
The SQS queue that messages will be sent to.
public IQueue Queue { get; set; }Property Value
StateName
Optional name for this state.
public string StateName { get; set; }Property Value
System.
Remarks
Default: - The construct ID will be used as state name
TaskTimeout
Timeout for the task.
public Timeout TaskTimeout { get; set; }Property Value
Remarks
[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface
Default: - None
Timeout
(deprecated) Timeout for the task.
public Duration Timeout { get; set; }Property Value
Remarks
Default: - None
Stability: Deprecated