Interface ParallelProps

All Superinterfaces:

AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, JsonPathCommonOptions, StateBaseProps

All Known Subinterfaces:

SingleStateOptions

All Known Implementing Classes:

ParallelProps.Jsii$Proxy, SingleStateOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
           date="2025-05-15T23:29:11.639Z")
@Stability(Stable)
public interface ParallelProps
extends software.amazon.jsii.JsiiSerializable, StateBaseProps, AssignableStateOptions, JsonPathCommonOptions, JsonataCommonOptions

Properties for defining a Parallel state.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 Object arguments_;
 Object assign;
 Object outputs;
 Object parameters;
 Object resultSelector;
 ParallelProps parallelProps = ParallelProps.builder()
         .arguments(Map.of(
                 "argumentsKey", arguments_))
         .assign(Map.of(
                 "assignKey", assign))
         .comment("comment")
         .inputPath("inputPath")
         .outputPath("outputPath")
         .outputs(outputs)
         .parameters(Map.of(
                 "parametersKey", parameters))
         .queryLanguage(QueryLanguage.JSON_PATH)
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .stateName("stateName")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ParallelProps.Builder	A builder for ParallelProps
static final class	ParallelProps.Jsii$Proxy	An implementation for ParallelProps

Method Summary

Modifier and Type	Method	Description
static ParallelProps.Builder	builder()
default Map<String,Object>	getArguments()	Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
default Map<String,Object>	getParameters()	Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
default String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
default Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions

getAssign

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions

getOutputs

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions

getInputPath, getOutputPath

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps

getComment, getQueryLanguage, getStateName

Method Details

getArguments

@Stability(Stable)
@Nullable
default Map<String,Object> getArguments()

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

Default: No arguments

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/transforming-data.html

getParameters

@Stability(Stable)
@Nullable
default Map<String,Object> getParameters()

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

Default: No parameters

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

getResultPath

@Stability(Stable)
@Nullable
default String getResultPath()

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: $

getResultSelector

@Stability(Stable)
@Nullable
default Map<String,Object> getResultSelector()

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

See Also:

• https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

builder

@Stability(Stable)
static ParallelProps.Builder builder()

Returns:

a ParallelProps.Builder of ParallelProps