Show / Hide Table of Contents

Interface IParallelJsonPathProps

Properties for defining a Parallel state that using JSONPath.

Inherited Members
IStateBaseProps.Comment
IStateBaseProps.QueryLanguage
IStateBaseProps.StateName
IAssignableStateOptions.Assign
IJsonPathCommonOptions.InputPath
IJsonPathCommonOptions.OutputPath
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IParallelJsonPathProps : IStateBaseProps, IAssignableStateOptions, IJsonPathCommonOptions
Syntax (vb)
Public Interface IParallelJsonPathProps Inherits IStateBaseProps, IAssignableStateOptions, IJsonPathCommonOptions
Remarks

ExampleMetadata: fixture=_generated

Examples
// 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 assign;
            var parameters;
            var resultSelector;

            var parallelJsonPathProps = new ParallelJsonPathProps {
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                InputPath = "inputPath",
                OutputPath = "outputPath",
                Parameters = new Dictionary<string, object> {
                    { "parametersKey", parameters }
                },
                QueryLanguage = QueryLanguage.JSON_PATH,
                ResultPath = "resultPath",
                ResultSelector = new Dictionary<string, object> {
                    { "resultSelectorKey", resultSelector }
                },
                StateName = "stateName"
            };

Synopsis

Properties

Parameters

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

ResultPath

JSONPath expression to indicate where to inject the state's output.

ResultSelector

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

Properties

Parameters

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

IDictionary<string, object>? Parameters { get; }
Property Value

IDictionary<string, object>

Remarks

Default: No parameters

See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

ResultPath

JSONPath expression to indicate where to inject the state's output.

string? ResultPath { get; }
Property Value

string

Remarks

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: $

ResultSelector

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

IDictionary<string, object>? ResultSelector { get; }
Property Value

IDictionary<string, object>

Remarks

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

Back to top Generated by DocFX