software.amazon.awscdk.services.stepfunctions

Interface TaskProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

TaskProps.Jsii$Proxy

Deprecated.

- replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

@Generated(value="jsii-pacmak/1.54.0 (build b1b977a)",
           date="2022-02-19T00:19:34.342Z")
 @Stability(value=Deprecated)
 @Deprecated
public interface TaskProps
extends software.amazon.jsii.JsiiSerializable

(deprecated) Props that are common to all tasks.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 import software.amazon.awscdk.core.*;
 Object parameters;
 IStepFunctionsTask stepFunctionsTask;
 TaskProps taskProps = TaskProps.builder()
         .task(stepFunctionsTask)
         // the properties below are optional
         .comment("comment")
         .inputPath("inputPath")
         .outputPath("outputPath")
         .parameters(Map.of(
                 "parametersKey", parameters))
         .resultPath("resultPath")
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TaskProps.Builder Deprecated.
static class	TaskProps.Jsii$Proxy Deprecated.

Method Summary

Modifier and Type	Method and Description
static TaskProps.Builder	builder() Deprecated.
default String	getComment() Deprecated.
default String	getInputPath() Deprecated.
default String	getOutputPath() Deprecated.
default Map<String,Object>	getParameters() Deprecated.
default String	getResultPath() Deprecated.
IStepFunctionsTask	getTask() Deprecated.
default Duration	getTimeout() Deprecated.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getTask

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

Deprecated.

(deprecated) Actual task to be invoked in this workflow.

getComment

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

Deprecated.

(deprecated) An optional description for this state.

Default: No comment

getInputPath

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

Deprecated.

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

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

Default: $

getOutputPath

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

Deprecated.

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

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

Default: $

getParameters

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

Deprecated.

(deprecated) 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

See Also:

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

getResultPath

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

Deprecated.

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

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

Default: $

getTimeout

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

Deprecated.

(deprecated) 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

builder

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

Deprecated.

Returns:

a TaskProps.Builder of TaskProps