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

(deprecated) Props that are common to all tasks.

Parameters

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

Deprecated

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

Stability

deprecated

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_stepfunctions as stepfunctions
import aws_cdk.core as cdk

# parameters: Any
# step_functions_task: stepfunctions.IStepFunctionsTask

task_props = stepfunctions.TaskProps(
    task=step_functions_task,

    # the properties below are optional
    comment="comment",
    input_path="inputPath",
    output_path="outputPath",
    parameters={
        "parameters_key": parameters
    },
    result_path="resultPath",
    timeout=cdk.Duration.minutes(30)
)

Attributes

comment¶

(deprecated) An optional description for this state.

Default: No comment
Stability: deprecated
Return type: Optional[str]

input_path¶

(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: $
Stability: deprecated
Return type: Optional[str]

output_path¶

(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: $
Stability: deprecated
Return type: Optional[str]

parameters¶

(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

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

Stability

deprecated

Return type

Optional[Mapping[str, Any]]

result_path¶

(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: $
Stability: deprecated
Return type: Optional[str]

task¶

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

Stability: deprecated
Return type: IStepFunctionsTask

timeout¶

(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
Stability: deprecated
Return type: Optional[Duration]