Package software.amazon.awscdk.services.stepfunctions.tasks

Interface StepFunctionsStartExecutionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

All Known Implementing Classes:

StepFunctionsStartExecutionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-10-31T19:13:06.719Z")
@Stability(Stable)
public interface StepFunctionsStartExecutionProps
extends software.amazon.jsii.JsiiSerializable, TaskStateBaseProps

Properties for StartExecution.

Example:

 // Define a state machine with one Pass state
 StateMachine child = StateMachine.Builder.create(this, "ChildStateMachine")
         .definition(Chain.start(new Pass(this, "PassState")))
         .build();
 // Include the state machine in a Task state with callback pattern
 StepFunctionsStartExecution task = StepFunctionsStartExecution.Builder.create(this, "ChildTask")
         .stateMachine(child)
         .integrationPattern(IntegrationPattern.WAIT_FOR_TASK_TOKEN)
         .input(TaskInput.fromObject(Map.of(
                 "token", JsonPath.getTaskToken(),
                 "foo", "bar")))
         .name("MyExecutionName")
         .build();
 // Define a second state machine with the Task state above
 // Define a second state machine with the Task state above
 StateMachine.Builder.create(this, "ParentStateMachine")
         .definition(task)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StepFunctionsStartExecutionProps.Builder	A builder for StepFunctionsStartExecutionProps
static final class	StepFunctionsStartExecutionProps.Jsii$Proxy	An implementation for StepFunctionsStartExecutionProps

Method Summary

Modifier and Type	Method	Description
static StepFunctionsStartExecutionProps.Builder	builder()
default Boolean	getAssociateWithParent()	Pass the execution ID from the context object to the execution input.
default TaskInput	getInput()	The JSON input for the execution, same as that of StartExecution.
default String	getName()	The name of the execution, same as that of StartExecution.
IStateMachine	getStateMachine()	The Step Functions state machine to start the execution on.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseProps

getComment, getCredentials, getHeartbeat, getHeartbeatTimeout, getInputPath, getIntegrationPattern, getOutputPath, getResultPath, getResultSelector, getStateName, getTaskTimeout, getTimeout

Method Details

getStateMachine

@Stability(Stable)
@NotNull
IStateMachine getStateMachine()

The Step Functions state machine to start the execution on.

getAssociateWithParent

@Stability(Stable)
@Nullable
default Boolean getAssociateWithParent()

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 Also:

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

getInput

@Stability(Stable)
@Nullable
default TaskInput getInput()

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

Default: - The state input (JSON path '$')

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

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

Default: - None

See Also:

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

builder

@Stability(Stable)
static StepFunctionsStartExecutionProps.Builder builder()

Returns:

a StepFunctionsStartExecutionProps.Builder of StepFunctionsStartExecutionProps