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.104.0 (build e79254c)", date="2024-11-27T16:51:05.943Z") @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))
         .stateName("stateName")
         .build();
 
  • 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:
    • getStateName

      @Stability(Stable) @Nullable default String getStateName()
      Optional name for this state.

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

    • builder

      @Stability(Stable) static ParallelProps.Builder builder()
      Returns:
      a ParallelProps.Builder of ParallelProps