Class TaskProps
(deprecated) Props that are common to all tasks.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.AWS.StepFunctions.dll
Syntax (csharp)
public class TaskProps : Object, ITaskProps
Syntax (vb)
Public Class TaskProps
Inherits Object
Implements ITaskProps
Remarks
Stability: Deprecated
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;
using Amazon.CDK;
var parameters;
IStepFunctionsTask stepFunctionsTask;
var taskProps = new TaskProps {
Task = stepFunctionsTask,
// the properties below are optional
Comment = "comment",
InputPath = "inputPath",
OutputPath = "outputPath",
Parameters = new Dictionary<string, object> {
{ "parametersKey", parameters }
},
ResultPath = "resultPath",
Timeout = Duration.Minutes(30)
};
Synopsis
Constructors
TaskProps() |
Properties
Comment | (deprecated) An optional description for this state. |
InputPath | (deprecated) JSONPath expression to select part of the state to be the input to this state. |
OutputPath | (deprecated) JSONPath expression to select part of the state to be the output to this state. |
Parameters | (deprecated) Parameters to invoke the task with. |
ResultPath | (deprecated) JSONPath expression to indicate where to inject the state's output. |
Task | (deprecated) Actual task to be invoked in this workflow. |
Timeout | (deprecated) Maximum run time of this state. |
Constructors
TaskProps()
public TaskProps()
Properties
Comment
(deprecated) An optional description for this state.
public string Comment { get; set; }
Property Value
System.String
Remarks
Default: No comment
Stability: Deprecated
InputPath
(deprecated) 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: $
Stability: Deprecated
OutputPath
(deprecated) 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: $
Stability: Deprecated
Parameters
(deprecated) Parameters to invoke the task with.
public IDictionary<string, object> Parameters { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
It is not recommended to use this field. The object that is passed in
the task
property will take care of returning the right values for the
Parameters
field in the Step Functions definition.
The various classes that implement IStepFunctionsTask
will take a
properties which make sense for the task type. For example, for
InvokeFunction
the field that populates the parameters
field will be
called payload
, and for the PublishToTopic
the parameters
field
will be populated via a combination of the referenced topic, subject and
message.
If passed anyway, the keys in this map will override the parameters returned by the task object.
Default: - Use the parameters implied by the task
property
Stability: Deprecated
ResultPath
(deprecated) 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: $
Stability: Deprecated
Task
(deprecated) Actual task to be invoked in this workflow.
public IStepFunctionsTask Task { get; set; }
Property Value
Remarks
Stability: Deprecated
Timeout
(deprecated) Maximum run time of this state.
public Duration Timeout { get; set; }
Property Value
Remarks
If the state takes longer than this amount of time to complete, a 'Timeout' error is raised.
Default: 60
Stability: Deprecated