AWS CDK Reference

Appearance

v2.276.0

WaitJsonataProps Struct ​

Properties for defining a Wait state that using JSONata.

Source
aws-stepfunctions/lib/states/wait.ts
Type last changed
v2.178.0 · 6 Feb 2025

Example ​

ts
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 }), ', ') %}",
  },
});
python
sfn.Wait.jsonata(self, "Wait",
    time=sfn.WaitTime.timestamp("{% $timestamp %}"),
    outputs={
        "string_argument": "inital-task",
        "number_argument": 123,
        "boolean_argument": True,
        "array_argument": [1, "{% $number %}", 3],
        "intrinsic_functions_argument": "{% $join($each($obj, function($v) { $v }), ', ') %}"
    }
)
java
Wait.jsonata(this, "Wait", WaitJsonataProps.builder()
        .time(WaitTime.timestamp("{% $timestamp %}"))
        .outputs(Map.of(
                "stringArgument", "inital-task",
                "numberArgument", 123,
                "booleanArgument", true,
                "arrayArgument", List.of(1, "{% $number %}", 3),
                "intrinsicFunctionsArgument", "{% $join($each($obj, function($v) { $v }), ', ') %}"))
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
Wait.Jsonata(this, "Wait", new WaitJsonataProps {
    Time = WaitTime.Timestamp("{% $timestamp %}"),
    Outputs = new Dictionary<string, object> {
        { "stringArgument", "inital-task" },
        { "numberArgument", 123 },
        { "booleanArgument", true },
        { "arrayArgument", new [] { 1, "{% $number %}", 3 } },
        { "intrinsicFunctionsArgument", "{% $join($each($obj, function($v) { $v }), ', ') %}" }
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
sfn.Wait_Jsonata(this, jsii.String("Wait"), &WaitJsonataProps{
	Time: sfn.WaitTime_Timestamp(jsii.String("{% $timestamp %}")),
	Outputs: map[string]interface{}{
		"stringArgument": jsii.String("inital-task"),
		"numberArgument": jsii.Number(123),
		"booleanArgument": jsii.Boolean(true),
		"arrayArgument": []interface{}{
			jsii.Number(1),
			jsii.String("{% $number %}"),
			jsii.Number(3),
		},
		"intrinsicFunctionsArgument": jsii.String("{% $join($each($obj, function($v) { $v }), ', ') %}"),
	},
})

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

outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#
Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

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.

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.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#
Optional name for this state.

Default: The construct ID will be used as state name

timeWaitTimetimeWaitTimetimeWaitTimeTimeWaitTimeTimeWaitTimerequired#
Wait duration.