Package software.amazon.awscdk.services.stepfunctions

Class Pass

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.services.stepfunctions.State

software.amazon.awscdk.services.stepfunctions.Pass

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:51.180Z")
@Stability(Stable)
public class Pass
extends State
implements INextable

Define a Pass in the state machine.

A Pass state can be used to transform the current execution's state.

Example:

 StateMachine stateMachine = StateMachine.Builder.create(this, "MyStateMachine")
         .stateMachineType(StateMachineType.EXPRESS)
         .definition(Chain.start(new Pass(this, "Pass")))
         .build();
 RestApi api = RestApi.Builder.create(this, "Api")
         .restApiName("MyApi")
         .build();
 api.root.addMethod("GET", StepFunctionsIntegration.startExecution(stateMachine));
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Pass.Builder	A fluent builder for Pass.

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.IChainable

IChainable.Jsii$Default

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

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

INextable.Jsii$Default, INextable.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
List<INextable>	getEndStates()	Continuable states of this Chainable.
static Pass	jsonata(software.constructs.Construct scope, String id)	Define a Pass using JSONata in the state machine.
static Pass	jsonata(software.constructs.Construct scope, String id, PassJsonataProps props)	Define a Pass using JSONata in the state machine.
static Pass	jsonPath(software.constructs.Construct scope, String id)	Define a Pass using JSONPath in the state machine.
static Pass	jsonPath(software.constructs.Construct scope, String id, PassJsonPathProps props)	Define a Pass using JSONPath in the state machine.
Chain	next(IChainable next)	Continue normal execution with the given state.
com.fasterxml.jackson.databind.node.ObjectNode	toStateJson()	Return the Amazon States Language object for this state.
com.fasterxml.jackson.databind.node.ObjectNode	toStateJson(QueryLanguage topLevelQueryLanguage)	Return the Amazon States Language object for this state.

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

addBranch, addChoice, addChoice, addItemProcessor, addItemProcessor, addIterator, addPrefix, bindToGraph, filterNextables, findReachableEndStates, findReachableEndStates, findReachableStates, findReachableStates, getArguments, getAssign, getBranches, getComment, getDefaultChoice, getId, getInputPath, getIteration, getOutputPath, getOutputs, getParameters, getProcessor, getProcessorConfig, getProcessorMode, getQueryLanguage, getResultPath, getResultSelector, getStartState, getStateId, getStateName, makeDefault, makeNext, prefixStates, renderAssign, renderAssign, renderBranches, renderChoices, renderChoices, renderInputOutput, renderItemProcessor, renderIterator, renderNextEnd, renderQueryLanguage, renderQueryLanguage, renderResultSelector, renderRetryCatch, renderRetryCatch, setDefaultChoice, setIteration, setProcessor, setProcessorConfig, setProcessorMode, validateState, whenBoundToGraph

Methods inherited from class software.constructs.Construct

getNode, isConstruct, 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 Details

Pass

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

Pass

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

Pass

@Stability(Stable)
public Pass(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 PassProps props)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

props -

Pass

@Stability(Stable)
public Pass(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - Descriptive identifier for this chainable. This parameter is required.

Method Details

jsonata

@Stability(Stable)
@NotNull
public static Pass jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 PassJsonataProps props)

Define a Pass using JSONata in the state machine.

A Pass state can be used to transform the current execution's state.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

jsonata

@Stability(Stable)
@NotNull
public static Pass jsonata(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Define a Pass using JSONata in the state machine.

A Pass state can be used to transform the current execution's state.

Parameters:

scope - This parameter is required.

id - This parameter is required.

jsonPath

@Stability(Stable)
@NotNull
public static Pass jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 PassJsonPathProps props)

Define a Pass using JSONPath in the state machine.

A Pass state can be used to transform the current execution's state.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

jsonPath

@Stability(Stable)
@NotNull
public static Pass jsonPath(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Define a Pass using JSONPath in the state machine.

A Pass state can be used to transform the current execution's state.

Parameters:

scope - This parameter is required.

id - This parameter is required.

next

@Stability(Stable)
@NotNull
public Chain next(@NotNull
 IChainable next)

Continue normal execution with the given state.

Specified by:

next in interface INextable

Parameters:

next - This parameter is required.

Returns:

The chain of states built up

toStateJson

@Stability(Stable)
@NotNull
public com.fasterxml.jackson.databind.node.ObjectNode toStateJson(@Nullable
 QueryLanguage topLevelQueryLanguage)

Return the Amazon States Language object for this state.

Specified by:

toStateJson in class State

Parameters:

topLevelQueryLanguage -

toStateJson

@Stability(Stable)
@NotNull
public com.fasterxml.jackson.databind.node.ObjectNode toStateJson()

Return the Amazon States Language object for this state.

Specified by:

toStateJson in class State

getEndStates

@Stability(Stable)
@NotNull
public List<INextable> getEndStates()

Continuable states of this Chainable.

Specified by:

getEndStates in interface IChainable

Specified by:

getEndStates in class State