Class TaskInput
Type union for task classes that accept multiple types of payload.
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class TaskInput : DeputyBaseSyntax (vb)
Public Class TaskInput Inherits DeputyBaseRemarks
ExampleMetadata: infused
Examples
using Amazon.CDK.AWS.APIGateway;
RestApi api;
CallApiGatewayRestApiEndpoint.Jsonata(this, "Endpoint", new CallApiGatewayRestApiEndpointJsonataProps {
Api = api,
StageName = "Stage",
Method = HttpMethod.PUT,
IntegrationPattern = IntegrationPattern.WAIT_FOR_TASK_TOKEN,
Headers = TaskInput.FromObject(new Dictionary<string, object> {
{ "TaskToken", "{% States.Array($states.context.taskToken) %}" }
})
});Synopsis
Properties
| Type | type of task input. |
| Value | payload for the corresponding input type. |
Methods
| FromJsonPathAt(string) | Use a part of the execution data or task context as task input. |
| FromObject(IDictionary<string, object>) | Use an object as task input. |
| FromText(string) | Use a literal string as task input. |
Properties
Type
type of task input.
public virtual InputType Type { get; }Property Value
Remarks
ExampleMetadata: infused
Value
payload for the corresponding input type.
public virtual object Value { get; }Property Value
Remarks
It can be a JSON-encoded object, context, data, etc.
Methods
FromJsonPathAt(string)
Use a part of the execution data or task context as task input.
public static TaskInput FromJsonPathAt(string path)Parameters
- path string
Returns
Remarks
Use this when you want to use a subobject or string from the current state machine execution or the current task context as complete payload to a task.
FromObject(IDictionary<string, object>)
Use an object as task input.
public static TaskInput FromObject(IDictionary<string, object> obj)Parameters
- obj IDictionary<string, object>
Returns
Remarks
This object may contain JSON path fields as object values, if desired.
Use sfn.JsonPath.DISCARD in place of null for languages that do not support null (i.e. Python).