interface WaitJsonataProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.WaitJsonataProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#WaitJsonataProps
Java	software.amazon.awscdk.services.stepfunctions.WaitJsonataProps
Python	aws_cdk.aws_stepfunctions.WaitJsonataProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » WaitJsonataProps

Properties for defining a Wait state that using JSONata.

Example

sfn.Wait.jsonata(this, 'Wait', {
  time: sfn.WaitTime.timestamp('{% $timestamp %}'),
  outputs: {
    stringArgument: 'inital-task',
    numberArgument: 123,
    booleanArgument: true,
    arrayArgument: [1, '{% $number %}', 3],
    intrinsicFunctionsArgument: "{% $join($each($obj, function($v) { $v }), ', ') %}",
  },
});

Properties

Name	Type	Description
time	WaitTime	Wait duration.
assign?	{ [string]: any }	Workflow variables to store in this step.
comment?	string	A comment describing this state.
outputs?	any	Used to specify and transform output from the state.
queryLanguage?	QueryLanguage	The name of the query language used by the state.
stateName?	string	Optional name for this state.

---

time

Type: WaitTime

Wait duration.

---

assign?

Type: { [string]: any } (optional, default: 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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

---

comment?

Type: string (optional, default: No comment)

A comment describing this state.

---

outputs?

Type: any (optional, default: $states.result or $states.errorOutput)

Used to specify and transform output from the state.

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.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

---

queryLanguage?

Type: QueryLanguage (optional, default: 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.

---

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.