aws-cdk-lib.aws_stepfunctions.JsonataStateOptions

JsonataStateOptions Struct

Option properties for JSONata task state.

JsonataStateOptions

extends

• JsonataCommonOptions

Source

aws-stepfunctions/lib/states/state.ts

Type last changed

v2.178.0 · 6 Feb 2025

Example

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

declare const arguments_: any;
declare const outputs: any;
const jsonataStateOptions: stepfunctions.JsonataStateOptions = {
  arguments: arguments_,
  outputs: outputs,
};

Properties

argumentsanyargumentsAnyargumentsObjectArgumentsobjectArgumentsinterface{}= No arguments#

Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

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