Class TaskInput

Type union for task classes that accept multiple types of payload.

Inheritance

System.Object

TaskInput

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class TaskInput : DeputyBase

Syntax (vb)

Public Class TaskInput
    Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

Function fn;

new LambdaInvoke(this, "Invoke with callback", new LambdaInvokeProps {
    LambdaFunction = fn,
    IntegrationPattern = IntegrationPattern.WAIT_FOR_TASK_TOKEN,
    Payload = TaskInput.FromObject(new Dictionary<string, object> {
        { "token", JsonPath.TaskToken },
        { "input", JsonPath.StringAt("$.someField") }
    })
});

Synopsis

Constructors

TaskInput(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
TaskInput(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

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.

Constructors

TaskInput(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected TaskInput(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

TaskInput(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected TaskInput(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

Type

type of task input.

public virtual InputType Type { get; }

Property Value

InputType

Value

payload for the corresponding input type.

public virtual object Value { get; }

Property Value

System.Object

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 System.String

Returns

TaskInput

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 System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

TaskInput

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).

FromText(String)

Use a literal string as task input.

public static TaskInput FromText(string text)

Parameters

text System.String

Returns

TaskInput

Remarks

This might be a JSON-encoded object, or just a text.