software.amazon.awscdk.services.stepfunctions

Interface ParallelProps

All Known Subinterfaces:

SingleStateOptions

All Known Implementing Classes:

ParallelProps.Jsii$Proxy, SingleStateOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:22.670Z")
public interface ParallelProps

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 and Description
static class	ParallelProps.Builder A builder for ParallelProps
static class	ParallelProps.Jsii$Proxy An implementation for ParallelProps

Method Summary

Modifier and Type	Method and Description
static ParallelProps.Builder	builder()
default java.lang.String	getComment() An optional description for this state.
default java.lang.String	getInputPath() JSONPath expression to select part of the state to be the input to this state.
default java.lang.String	getOutputPath() JSONPath expression to select part of the state to be the output to this state.
default java.lang.String	getResultPath() JSONPath expression to indicate where to inject the state's output.
default java.util.Map<java.lang.String,java.lang.Object>	getResultSelector() The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

Method Detail

getComment

default java.lang.String getComment()

An optional description for this state.

Default: No comment

getInputPath

default java.lang.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

default java.lang.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

default java.lang.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

default java.util.Map<java.lang.String,java.lang.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

static ParallelProps.Builder builder()

Returns:

a ParallelProps.Builder of ParallelProps