StepFunctionsStartExecutionProps

class aws_cdk.aws_stepfunctions_tasks.StepFunctionsStartExecutionProps(*, comment=None, heartbeat=None, input_path=None, integration_pattern=None, output_path=None, result_path=None, result_selector=None, timeout=None, state_machine, associate_with_parent=None, input=None, name=None)

Bases: aws_cdk.aws_stepfunctions.TaskStateBaseProps

Properties for StartExecution.

Parameters

  • comment (Optional[str]) – An optional description for this state. Default: - No comment

  • heartbeat (Optional[Duration]) – Timeout for the heartbeat. Default: - None

  • 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 JsonPath.DISCARD, which will cause the effective input to be the empty object {}. Default: - The entire task input (JSON path ‘$’)

  • integration_pattern (Optional[IntegrationPattern]) – AWS Step Functions integrates with services directly in the Amazon States Language. You can control these AWS services using service integration patterns Default: - IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

  • output_path (Optional[str]) – JSONPath expression to select select a portion of the state output to pass to the next state. May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}. Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path ‘$’)

  • result_path (Optional[str]) – 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: - Replaces the entire input with the result (JSON path ‘$’)

  • result_selector (Optional[Mapping[str, Any]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - None

  • timeout (Optional[Duration]) – Timeout for the state machine. Default: - None

  • state_machine (IStateMachine) – The Step Functions state machine to start the execution on.

  • associate_with_parent (Optional[bool]) – Pass the execution ID from the context object to the execution input. This allows the Step Functions UI to link child executions from parent executions, making it easier to trace execution flow across state machines. If you set this property to true, the input property must be an object (provided by sfn.TaskInput.fromObject) or omitted entirely. Default: - false

  • input (Optional[TaskInput]) – The JSON input for the execution, same as that of StartExecution. Default: - The state input (JSON path ‘$’)

  • name (Optional[str]) – The name of the execution, same as that of StartExecution. Default: - None

ExampleMetadata

infused

Example:

# Define a state machine with one Pass state
child = sfn.StateMachine(self, "ChildStateMachine",
    definition=sfn.Chain.start(sfn.Pass(self, "PassState"))
)

# Include the state machine in a Task state with callback pattern
task = tasks.StepFunctionsStartExecution(self, "ChildTask",
    state_machine=child,
    integration_pattern=sfn.IntegrationPattern.WAIT_FOR_TASK_TOKEN,
    input=sfn.TaskInput.from_object({
        "token": sfn.JsonPath.task_token,
        "foo": "bar"
    }),
    name="MyExecutionName"
)

# Define a second state machine with the Task state above
sfn.StateMachine(self, "ParentStateMachine",
    definition=task
)

Attributes

associate_with_parent

Pass the execution ID from the context object to the execution input.

This allows the Step Functions UI to link child executions from parent executions, making it easier to trace execution flow across state machines.

If you set this property to true, the input property must be an object (provided by sfn.TaskInput.fromObject) or omitted entirely.

Default

  • false

See

https://docs.aws.amazon.com/step-functions/latest/dg/concepts-nested-workflows.html#nested-execution-startid

Return type

Optional[bool]

comment

An optional description for this state.

Default

  • No comment

Return type

Optional[str]

heartbeat

Timeout for the heartbeat.

Default

  • None

Return type

Optional[Duration]

input

The JSON input for the execution, same as that of StartExecution.

Default

  • The state input (JSON path ‘$’)

See

https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html

Return type

Optional[TaskInput]

input_path

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

  • The entire task input (JSON path ‘$’)

Return type

Optional[str]

integration_pattern

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns

Default

  • IntegrationPattern.REQUEST_RESPONSE for most tasks.

IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

See

https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

Return type

Optional[IntegrationPattern]

name

The name of the execution, same as that of StartExecution.

Default

  • None

See

https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html

Return type

Optional[str]

output_path

JSONPath expression to select select a portion of the state output to pass to the next state.

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

Default

  • The entire JSON node determined by the state input, the task result,

and resultPath is passed to the next state (JSON path ‘$’)

Return type

Optional[str]

result_path

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

  • Replaces the entire input with the result (JSON path ‘$’)

Return type

Optional[str]

result_selector

The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.

Default

  • None

See

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

Return type

Optional[Mapping[str, Any]]

state_machine

The Step Functions state machine to start the execution on.

Return type

IStateMachine

timeout

Timeout for the state machine.

Default

  • None

Return type

Optional[Duration]