# JsonataStateProps

Properties shared by all states that use JSONata.

Extends: JsonataStateProps
Extends: StateBaseProps, JsonataStateOptions, AssignableStateOptions

- Source: [`aws-stepfunctions/lib/states/state.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-stepfunctions/lib/states/state.ts#L158)
- Type last changed: v2.178.0 · 6 Feb 2025

## Example

```ts
// 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 assign: any;
declare const outputs: any;
const jsonataStateProps: stepfunctions.JsonataStateProps = {
  arguments: arguments_,
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  outputs: outputs,
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
};
```

## Properties

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

  **Default:** No arguments

- `assign`: { [key: string]: any } — 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.

- `comment`: string — A comment describing this state.

  **Default:** No comment

- `outputs`: any — Used to specify and transform output from the state.

  **Default:** $states.result or $states.errorOutput

  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.

- `queryLanguage`: [QueryLanguage](/cdk/api/v2/docs/aws-cdk-lib.aws_stepfunctions.QueryLanguage.html) = 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`: string — Optional name for this state.

  **Default:** The construct ID will be used as state name