Package software.amazon.awscdk.services.stepfunctions

Interface ParallelJsonPathProps

All Superinterfaces:

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

All Known Implementing Classes:

ParallelJsonPathProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:21.344Z")
@Stability(Stable)
public interface ParallelJsonPathProps
extends software.amazon.jsii.JsiiSerializable, StateBaseProps, AssignableStateOptions, JsonPathCommonOptions

Properties for defining a Parallel state that using JSONPath.

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 assign;
 Object resultSelector;
 ParallelJsonPathProps parallelJsonPathProps = ParallelJsonPathProps.builder()
         .assign(Map.of(
                 "assignKey", assign))
         .comment("comment")
         .inputPath("inputPath")
         .outputPath("outputPath")
         .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	ParallelJsonPathProps.Builder	A builder for ParallelJsonPathProps
static final class	ParallelJsonPathProps.Jsii$Proxy	An implementation for ParallelJsonPathProps

Method Summary

Modifier and Type	Method	Description
static ParallelJsonPathProps.Builder	builder()
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.JsonPathCommonOptions

getInputPath, getOutputPath

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

getComment, getQueryLanguage, getStateName

Method Details

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 ParallelJsonPathProps.Builder builder()

Returns:

a ParallelJsonPathProps.Builder of ParallelJsonPathProps