TaskProps¶

class aws_cdk.aws_stepfunctions.TaskProps(*, task, comment=None, input_path=None, output_path=None, parameters=None, result_path=None, timeout=None)¶

Bases: object

__init__(*, task, comment=None, input_path=None, output_path=None, parameters=None, result_path=None, timeout=None)¶

Props that are common to all tasks.

Parameters

task (IStepFunctionsTask) – Actual task to be invoked in this workflow.
comment (Optional[str]) – An optional description for this state. Default: No comment
input_path (Optional[str]) – 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: $
output_path (Optional[str]) – 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: $
parameters (Optional[Mapping[str, Any]]) – 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
result_path (Optional[str]) – 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: $
timeout (Optional[Duration]) – 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

stability :stability: experimental

Return type: None

Attributes

comment¶

An optional description for this state.

default :default: No comment

stability :stability: experimental

Return type: Optional[str]

input_path¶

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 :default: $

stability :stability: experimental

Return type: Optional[str]

output_path¶

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 :default: $

stability :stability: experimental

Return type: Optional[str]

parameters¶

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 :default: - Use the parameters implied by the task property

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

Return type: Optional[Mapping[str, Any]]

result_path¶

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 :default: $

stability :stability: experimental

Return type: Optional[str]

task¶

Actual task to be invoked in this workflow.

stability :stability: experimental

Return type: IStepFunctionsTask

timeout¶

Maximum run time of this state.

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

default :default: 60

stability :stability: experimental

Return type: Optional[Duration]