L2 Construct

Parallel

Define a Parallel state in the state machine. A Parallel state can be used to run one or more state machines at the same time. The Result of a Parallel state is an array of the results of its substatemachines.

Import

import { Parallel } from 'aws-cdk-lib/aws-stepfunctions';

Or use the module namespace:

import * as stepfunctions from 'aws-cdk-lib/aws-stepfunctions';
// stepfunctions.Parallel

Properties

Configuration passed to the constructor as ParallelProps.

argumentsOptional

{ [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

parametersOptional

{ [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

resultPathOptional

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.

Default: $

resultSelectorOptional

{ [key: string]: any }

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.

Default: - None

3 properties inherited from StateBaseProps

commentOptionalinherited from StateBaseProps

string

A comment describing this state.

Default: No comment

queryLanguageOptionalinherited from StateBaseProps

QueryLanguage

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.

Default: - JSONPath

stateNameOptionalinherited from StateBaseProps

string

Optional name for this state.

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

1 property inherited from AssignableStateOptions

assignOptionalinherited from AssignableStateOptions

{ [key: string]: any }

Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

2 properties inherited from JsonPathCommonOptions

inputPathOptionalinherited from JsonPathCommonOptions

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 {}.

Default: $

outputPathOptionalinherited from JsonPathCommonOptions

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 {}.

Default: $

1 property inherited from JsonataCommonOptions

outputsOptionalinherited from JsonataCommonOptions

any

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.

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

Get the AWS Step Functions Cheat Sheet

Everything you need to know about AWS Step Functions on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL2 (Higher-level)

Moduleaws-stepfunctions

Properties11

Related Constructs

Explore This Service

External Links

CDK API Documentation