Interface IStateProps
Properties shared by all states.
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.AWS.StepFunctions.dll
Syntax (csharp)
public interface IStateProps
Syntax (vb)
Public Interface IStateProps
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 parameters;
var resultSelector;
var stateProps = new StateProps {
Comment = "comment",
InputPath = "inputPath",
OutputPath = "outputPath",
Parameters = new Dictionary<string, object> {
{ "parametersKey", parameters }
},
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
}
};
Synopsis
Properties
Comment | A comment describing this state. |
InputPath | JSONPath expression to select part of the state to be the input to this state. |
OutputPath | JSONPath expression to select part of the state to be the output to this state. |
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
Comment
A comment describing this state.
virtual string Comment { get; }
Property Value
System.String
Remarks
Default: No comment
InputPath
JSONPath expression to select part of the state to be the input to this state.
virtual string InputPath { get; }
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: $
OutputPath
JSONPath expression to select part of the state to be the output to this state.
virtual string OutputPath { get; }
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
Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
virtual IDictionary<string, object> Parameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: No parameters
ResultPath
JSONPath expression to indicate where to inject the state's output.
virtual string ResultPath { get; }
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.
virtual IDictionary<string, object> ResultSelector { get; }
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