Package software.amazon.awscdk.services.stepfunctions

Interface ParallelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SingleStateOptions

All Known Implementing Classes:

ParallelProps.Jsii$Proxy, SingleStateOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.924Z")
@Stability(Stable)
public interface ParallelProps
extends software.amazon.jsii.JsiiSerializable

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 resultSelector;
 ParallelProps parallelProps = ParallelProps.builder()
         .comment("comment")
         .inputPath("inputPath")
         .outputPath("outputPath")
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .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 String	getComment()	An optional description for this state.
default String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
default String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
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.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComment

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

An optional description for this state.

Default: No comment

getInputPath

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

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

getOutputPath

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

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

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