ParallelProps Struct
Properties for defining a Parallel state.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
declare const arguments_: any;
declare const assign: any;
declare const outputs: any;
declare const parameters: any;
declare const resultSelector: any;
const parallelProps: stepfunctions.ParallelProps = {
arguments: {
argumentsKey: arguments_,
},
assign: {
assignKey: assign,
},
comment: 'comment',
inputPath: 'inputPath',
outputPath: 'outputPath',
outputs: outputs,
parameters: {
parametersKey: parameters,
},
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
stateName: 'stateName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions
# arguments_: Any
# assign: Any
# outputs: Any
# parameters: Any
# result_selector: Any
parallel_props = stepfunctions.ParallelProps(
arguments={
"arguments_key": arguments_
},
assign={
"assign_key": assign
},
comment="comment",
input_path="inputPath",
output_path="outputPath",
outputs=outputs,
parameters={
"parameters_key": parameters
},
query_language=stepfunctions.QueryLanguage.JSON_PATH,
result_path="resultPath",
result_selector={
"result_selector_key": result_selector
},
state_name="stateName"
)
java
// 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();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;
var arguments_;
var assign;
var outputs;
var parameters;
var resultSelector;
var parallelProps = new ParallelProps {
Arguments = new Dictionary<string, object> {
{ "argumentsKey", arguments_ }
},
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
InputPath = "inputPath",
OutputPath = "outputPath",
Outputs = outputs,
Parameters = new Dictionary<string, object> {
{ "parametersKey", parameters }
},
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
StateName = "stateName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
var arguments_ interface{}
var assign interface{}
var outputs interface{}
var parameters interface{}
var resultSelector interface{}
parallelProps := &ParallelProps{
Arguments: map[string]interface{}{
"argumentsKey": arguments_,
},
Assign: map[string]interface{}{
"assignKey": assign,
},
Comment: jsii.String("comment"),
InputPath: jsii.String("inputPath"),
OutputPath: jsii.String("outputPath"),
Outputs: outputs,
Parameters: map[string]interface{}{
"parametersKey": parameters,
},
QueryLanguage: awscdk.Aws_stepfunctions.QueryLanguage_JSON_PATH,
ResultPath: jsii.String("resultPath"),
ResultSelector: map[string]interface{}{
"resultSelectorKey": resultSelector,
},
StateName: jsii.String("stateName"),
}
Properties
argumentsoptional{ [key: string]: any }argumentsoptionaltyping.Mapping[str, Any]argumentsoptionalMap<String, Object>ArgumentsoptionalIDictionary<string, object>Argumentsoptional*map[string]interface{}#Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
Default: No arguments
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#Workflow variables to store in this step.
Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#A comment describing this state.
Default: No comment
inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string= $#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 {}.
outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string= $#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 {}.
outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#Used to specify and transform output from the state.
Default: $states.result or $states.errorOutput
notes
When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
parametersoptional{ [key: string]: any }parametersoptionaltyping.Mapping[str, Any]parametersoptionalMap<String, Object>ParametersoptionalIDictionary<string, object>Parametersoptional*map[string]interface{}#Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
Default: No parameters
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#The name of the query language used by the state.
If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
resultPathoptionalstringresult_pathoptionalstrresultPathoptionalStringResultPathoptionalstringResultPathoptional*string= $#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.
resultSelectoroptional{ [key: string]: any }result_selectoroptionaltyping.Mapping[str, Any]resultSelectoroptionalMap<String, Object>ResultSelectoroptionalIDictionary<string, object>ResultSelectoroptional*map[string]interface{}= None#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.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#Optional name for this state.
Default: The construct ID will be used as state name