software.amazon.awscdk.services.stepfunctions.tasks

Class StepFunctionsStartExecution

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.TaskStateBase

software.amazon.awscdk.services.stepfunctions.tasks.StepFunctionsStartExecution

All Implemented Interfaces:

IDependable, IChainable, INextable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2023-01-03T16:22:40.747Z")
 @Stability(value=Stable)
public class StepFunctionsStartExecution
extends TaskStateBase

A Step Functions Task to call StartExecution on another state machine.

It supports three service integration patterns: REQUEST_RESPONSE, RUN_JOB, and WAIT_FOR_TASK_TOKEN.

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	Class and Description
static class	StepFunctionsStartExecution.Builder A fluent builder for StepFunctionsStartExecution.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.INextable

INextable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor and Description
	StepFunctionsStartExecution(software.constructs.Construct scope, String id, StepFunctionsStartExecutionProps props)
protected	StepFunctionsStartExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StepFunctionsStartExecution(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected TaskMetricsConfig	getTaskMetrics()
protected List<PolicyStatement>	getTaskPolicies()

Methods inherited from class software.amazon.awscdk.services.stepfunctions.TaskStateBase

addCatch, addCatch, addRetry, addRetry, getEndStates, metric, metric, metricFailed, metricFailed, metricHeartbeatTimedOut, metricHeartbeatTimedOut, metricRunTime, metricRunTime, metricScheduled, metricScheduled, metricScheduleTime, metricScheduleTime, metricStarted, metricStarted, metricSucceeded, metricSucceeded, metricTime, metricTime, metricTimedOut, metricTimedOut, next, toStateJson, whenBoundToGraph

Methods inherited from class software.amazon.awscdk.services.stepfunctions.State

addBranch, addChoice, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getParameters, getResultPath, getResultSelector, getStartState, getStateId, makeDefault, makeNext, prefixStates, renderBranches, renderChoices, renderInputOutput, renderIterator, renderNextEnd, renderResultSelector, renderRetryCatch, setDefaultChoice, setIteration

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.constructs.Construct

toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

StepFunctionsStartExecution

protected StepFunctionsStartExecution(software.amazon.jsii.JsiiObjectRef objRef)

StepFunctionsStartExecution

protected StepFunctionsStartExecution(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StepFunctionsStartExecution

@Stability(value=Stable)
public StepFunctionsStartExecution(@NotNull
                                                            software.constructs.Construct scope,
                                                            @NotNull
                                                            String id,
                                                            @NotNull
                                                            StepFunctionsStartExecutionProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

getTaskMetrics

@Stability(value=Stable)
 @Nullable
protected TaskMetricsConfig getTaskMetrics()

Specified by:

getTaskMetrics in class TaskStateBase

getTaskPolicies

@Stability(value=Stable)
 @Nullable
protected List<PolicyStatement> getTaskPolicies()

Specified by:

getTaskPolicies in class TaskStateBase