Interface ITaskStateJsonPathBaseProps
Props that are common to all tasks that using JSONPath.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ITaskStateJsonPathBaseProps : IStateBaseProps, ITaskStateBaseOptions, IAssignableStateOptions, IJsonPathCommonOptions
Syntax (vb)
Public Interface ITaskStateJsonPathBaseProps Inherits IStateBaseProps, ITaskStateBaseOptions, 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;
using Amazon.CDK.AWS.StepFunctions;
var assign;
var resultSelector;
TaskRole taskRole;
Timeout timeout;
var taskStateJsonPathBaseProps = new TaskStateJsonPathBaseProps {
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
Credentials = new Credentials {
Role = taskRole
},
Heartbeat = Duration.Minutes(30),
HeartbeatTimeout = timeout,
InputPath = "inputPath",
IntegrationPattern = IntegrationPattern.REQUEST_RESPONSE,
OutputPath = "outputPath",
QueryLanguage = QueryLanguage.JSON_PATH,
ResultPath = "resultPath",
ResultSelector = new Dictionary<string, object> {
{ "resultSelectorKey", resultSelector }
},
StateName = "stateName",
TaskTimeout = timeout,
Timeout = Duration.Minutes(30)
};
Synopsis
Properties
| 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
ResultPath
JSONPath expression to indicate where to inject the state's output.
string? ResultPath { get; }
Property Value
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
Remarks
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
Default: - None