Interface IStepFunctionsStartExecutionProps
Properties for StartExecution.
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions.Tasks
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IStepFunctionsStartExecutionProps : ITaskStateBaseProps
Syntax (vb)
Public Interface IStepFunctionsStartExecutionProps
Inherits ITaskStateBaseProps
Remarks
ExampleMetadata: infused
Examples
// Define a state machine with one Pass state
var child = new StateMachine(this, "ChildStateMachine", new StateMachineProps {
Definition = Chain.Start(new Pass(this, "PassState"))
});
// Include the state machine in a Task state with callback pattern
var task = new StepFunctionsStartExecution(this, "ChildTask", new StepFunctionsStartExecutionProps {
StateMachine = child,
IntegrationPattern = IntegrationPattern.WAIT_FOR_TASK_TOKEN,
Input = TaskInput.FromObject(new Dictionary<string, object> {
{ "token", JsonPath.TaskToken },
{ "foo", "bar" }
}),
Name = "MyExecutionName"
});
// Define a second state machine with the Task state above
// Define a second state machine with the Task state above
new StateMachine(this, "ParentStateMachine", new StateMachineProps {
Definition = task
});
Synopsis
Properties
AssociateWithParent | Pass the execution ID from the context object to the execution input. |
Input | The JSON input for the execution, same as that of StartExecution. |
Name | The name of the execution, same as that of StartExecution. |
StateMachine | The Step Functions state machine to start the execution on. |
Properties
AssociateWithParent
Pass the execution ID from the context object to the execution input.
virtual Nullable<bool> AssociateWithParent { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
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
The JSON input for the execution, same as that of StartExecution.
virtual TaskInput Input { get; }
Property Value
Remarks
Default: - The state input (JSON path '$')
See: https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html
Name
The name of the execution, same as that of StartExecution.
virtual string Name { get; }
Property Value
System.String
Remarks
StateMachine
The Step Functions state machine to start the execution on.
IStateMachine StateMachine { get; }
Property Value