software.amazon.awscdk.services.stepfunctions

Interface TaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TaskProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.5.0 (build 46538f8)",
           date="2020-05-15T23:35:58.931Z")
 @Stability(value=Experimental)
public interface TaskProps
extends software.amazon.jsii.JsiiSerializable

Props that are common to all tasks.

EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TaskProps.Builder A builder for TaskProps
static class	TaskProps.Jsii$Proxy An implementation for TaskProps

Method Summary

Modifier and Type	Method and Description
static TaskProps.Builder	builder()
default String	getComment() An optional description for this state.
default String	getInputPath() JSONPath expression to select part of the state to be the input to this state.
default String	getOutputPath() JSONPath expression to select part of the state to be the output to this state.
default Map<String,Object>	getParameters() Parameters to invoke the task with.
default String	getResultPath() JSONPath expression to indicate where to inject the state's output.
IStepFunctionsTask	getTask() Actual task to be invoked in this workflow.
default Duration	getTimeout() Maximum run time of this state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTask

@Stability(value=Experimental)
 @NotNull
IStepFunctionsTask getTask()

Actual task to be invoked in this workflow.

EXPERIMENTAL

getComment

@Stability(value=Experimental)
 @Nullable
default String getComment()

An optional description for this state.

Default: No comment

EXPERIMENTAL

getInputPath

@Stability(value=Experimental)
 @Nullable
default String getInputPath()

JSONPath expression to select part of the state to be the input to this state.

May also be the special value DISCARD, which will cause the effective input to be the empty object {}.

Default: $

EXPERIMENTAL

getOutputPath

@Stability(value=Experimental)
 @Nullable
default String getOutputPath()

JSONPath expression to select part of the state to be the output to this state.

May also be the special value DISCARD, which will cause the effective output to be the empty object {}.

Default: $

EXPERIMENTAL

getParameters

@Stability(value=Experimental)
 @Nullable
default Map<String,Object> getParameters()

Parameters to invoke the task with.

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

EXPERIMENTAL

See Also:

https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

getResultPath

@Stability(value=Experimental)
 @Nullable
default String getResultPath()

JSONPath expression to indicate where to inject the state's output.

May also be the special value DISCARD, which will cause the state's input to become its output.

Default: $

EXPERIMENTAL

getTimeout

@Stability(value=Experimental)
 @Nullable
default Duration getTimeout()

Maximum run time of this state.

If the state takes longer than this amount of time to complete, a 'Timeout' error is raised.

Default: 60

EXPERIMENTAL

builder

@Stability(value=Experimental)
static TaskProps.Builder builder()

Returns:

a TaskProps.Builder of TaskProps