Interface StepFunctionsStartExecutionProps
- All Superinterfaces:
- AssignableStateOptions,- software.amazon.jsii.JsiiSerializable,- JsonataCommonOptions,- JsonPathCommonOptions,- StateBaseProps,- TaskStateBaseOptions,- TaskStateBaseProps
- All Known Implementing Classes:
- StepFunctionsStartExecutionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:49.999Z")
@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 SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forStepFunctionsStartExecutionPropsstatic final classAn implementation forStepFunctionsStartExecutionProps
- 
Method SummaryModifier and TypeMethodDescriptionbuilder()default BooleanPass the execution ID from the context object to the execution input.default TaskInputgetInput()The JSON input for the execution, same as that of StartExecution.default StringgetName()The name of the execution, same as that of StartExecution.The Step Functions state machine to start the execution on.Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptionsgetAssignMethods inherited from interface software.amazon.jsii.JsiiSerializable$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptionsgetOutputsMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptionsgetInputPath, getOutputPathMethods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBasePropsgetComment, getQueryLanguage, getStateNameMethods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptionsgetCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeoutMethods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBasePropsgetResultPath, getResultSelector
- 
Method Details- 
getStateMachineThe Step Functions state machine to start the execution on.
- 
getAssociateWithParentPass 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, theinputproperty must be an object (provided bysfn.TaskInput.fromObject) or omitted entirely.Default: - false - See Also:
 
- 
getInputThe JSON input for the execution, same as that of StartExecution.Default: - The state input (JSON path '$') - See Also:
 
- 
getNameThe name of the execution, same as that of StartExecution.Default: - None - See Also:
 
- 
builder
 
-