# ParallelProps

Properties for defining a Parallel state.

Extends: ParallelProps
Extends: StateBaseProps, AssignableStateOptions, JsonPathCommonOptions, JsonataCommonOptions
Used as props by: Parallel

- Source: [`aws-stepfunctions/lib/states/parallel.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-stepfunctions/lib/states/parallel.ts#L71)
- Type last changed: v2.196.0 · 16 May 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;
declare const parameters: any;
declare const resultSelector: any;
const parallelProps: stepfunctions.ParallelProps = {
  arguments: {
    argumentsKey: arguments_,
  },
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  inputPath: 'inputPath',
  outputPath: 'outputPath',
  outputs: outputs,
  parameters: {
    parametersKey: parameters,
  },
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
};
```

## Properties

- `arguments`: { [key: string]: 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

- `inputPath`: string = $ — JSONPath expression to select part of the state to be the input to this state.

  May also be the special value JsonPath.DISCARD, which will cause the effective
  input to be the empty object {}.

- `outputPath`: string = $ — JSONPath expression to select part of the state to be the output to this state.

  May also be the special value JsonPath.DISCARD, which will cause the effective
  output to be the empty object {}.

- `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.

- `parameters`: { [key: string]: any } — Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

  **Default:** No parameters

- `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.

- `resultPath`: string = $ — JSONPath expression to indicate where to inject the state's output.

  May also be the special value JsonPath.DISCARD, which will cause the state's
  input to become its output.

- `resultSelector`: { [key: string]: any } = None — The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

  You can use ResultSelector to create a payload with values that are static
  or selected from the state's raw result.

- `stateName`: string — Optional name for this state.

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