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 pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. Default: No parameters

  • 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

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 pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

default :default: No parameters

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]