Interface StepFunctionsStartExecutionJsonataProps
- All Superinterfaces:
AssignableStateOptions
,software.amazon.jsii.JsiiSerializable
,JsonataCommonOptions
,StateBaseProps
,TaskStateBaseOptions
,TaskStateJsonataBaseProps
- All Known Implementing Classes:
StepFunctionsStartExecutionJsonataProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
date="2025-06-13T09:19:47.682Z")
@Stability(Stable)
public interface StepFunctionsStartExecutionJsonataProps
extends software.amazon.jsii.JsiiSerializable, TaskStateJsonataBaseProps
Properties for StartExecution using JSONata.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.*; import software.amazon.awscdk.services.stepfunctions.*; import software.amazon.awscdk.services.stepfunctions.tasks.*; Object assign; Object outputs; StateMachine stateMachine; TaskInput taskInput; TaskRole taskRole; Timeout timeout; StepFunctionsStartExecutionJsonataProps stepFunctionsStartExecutionJsonataProps = StepFunctionsStartExecutionJsonataProps.builder() .stateMachine(stateMachine) // the properties below are optional .assign(Map.of( "assignKey", assign)) .associateWithParent(false) .comment("comment") .credentials(Credentials.builder() .role(taskRole) .build()) .heartbeat(Duration.minutes(30)) .heartbeatTimeout(timeout) .input(taskInput) .integrationPattern(IntegrationPattern.REQUEST_RESPONSE) .name("name") .outputs(outputs) .queryLanguage(QueryLanguage.JSON_PATH) .stateName("stateName") .taskTimeout(timeout) .timeout(Duration.minutes(30)) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forStepFunctionsStartExecutionJsonataProps
static final class
An implementation forStepFunctionsStartExecutionJsonataProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Boolean
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.The Step Functions state machine to start the execution on.Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssign
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions
getOutputs
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateName
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.TaskStateBaseOptions
getCredentials, getHeartbeat, getHeartbeatTimeout, getIntegrationPattern, getTaskTimeout, getTimeout
-
Method Details
-
getStateMachine
The Step Functions state machine to start the execution on. -
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
, theinput
property must be an object (provided bysfn.TaskInput.fromObject
) or omitted entirely.Default: - false
- See Also:
-
getInput
The JSON input for the execution, same as that of StartExecution.Default: - The state input (JSON path '$')
- See Also:
-
getName
The name of the execution, same as that of StartExecution.Default: - None
- See Also:
-
builder
-