Class MapProps
Properties for defining a Map state.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.AWS.StepFunctions.dll
Syntax (csharp)
public class MapProps : Object, IMapProps
Syntax (vb)
Public Class MapProps
Inherits Object
Implements IMapProps
Remarks
ExampleMetadata: infused
Examples
var map = new Map(this, "Map State", new MapProps {
MaxConcurrency = 1,
ItemsPath = JsonPath.StringAt("$.inputForMap")
});
map.Iterator(new Pass(this, "Pass State"));
Synopsis
Constructors
MapProps() |
Properties
Comment | An optional description for this state. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
ItemsPath | JSONPath expression to select the array to iterate over. |
MaxConcurrency | MaxConcurrency. |
OutputPath | JSONPath expression to select part of the state to be the output to this state. |
Parameters | The JSON that you want to override your default iteration 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. |
Constructors
MapProps()
public MapProps()
Properties
Comment
An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: No comment
InputPath
JSONPath expression to select part of the state to be the input to this state.
public string InputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
Default: $
ItemsPath
JSONPath expression to select the array to iterate over.
public string ItemsPath { get; set; }
Property Value
System.String
Remarks
Default: $
MaxConcurrency
MaxConcurrency.
public Nullable<double> MaxConcurrency { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
An upper bound on the number of iterations you want running at once.
Default: - full concurrency
OutputPath
JSONPath expression to select part of the state to be the output to this state.
public string OutputPath { get; set; }
Property Value
System.String
Remarks
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
Default: $
Parameters
The JSON that you want to override your default iteration input.
public IDictionary<string, object> Parameters { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: $
ResultPath
JSONPath expression to indicate where to inject the state's output.
public string ResultPath { get; set; }
Property Value
System.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.
public IDictionary<string, object> ResultSelector { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.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