class Pass (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.Pass |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#Pass |
![]() | software.amazon.awscdk.services.stepfunctions.Pass |
![]() | aws_cdk.aws_stepfunctions.Pass |
![]() | aws-cdk-lib » aws_stepfunctions » Pass |
Implements
IConstruct
, IDependable
, IChainable
, INextable
Define a Pass in the state machine.
A Pass state can be used to transform the current execution's state.
Example
const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', {
stateMachineType: stepfunctions.StateMachineType.EXPRESS,
definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')),
});
const api = new apigateway.RestApi(this, 'Api', {
restApiName: 'MyApi',
});
api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));
Initializer
new Pass(scope: Construct, id: string, props?: PassProps)
Parameters
Construct Props
Name | Type | Description |
---|---|---|
assign? | { [string]: any } | Workflow variables to store in this step. |
comment? | string | A comment describing this state. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
outputs? | any | Used to specify and transform output from the state. |
parameters? | { [string]: any } | Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. |
query | Query | The name of the query language used by the state. |
result? | Result | If given, treat as the result of this operation. |
result | string | JSONPath expression to indicate where to inject the state's output. |
state | string | Optional name for this state. |
assign?
Type:
{ [string]: any }
(optional, default: Not assign variables)
Workflow variables to store in this step.
Using workflow variables, you can store data in a step and retrieve that data in future steps.
comment?
Type:
string
(optional, default: No comment)
A comment describing this state.
inputPath?
Type:
string
(optional, default: $)
JSONPath expression to select part of the state to be the input to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.
outputPath?
Type:
string
(optional, default: $)
JSONPath expression to select part of the state to be the output to this state.
May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.
outputs?
Type:
any
(optional, default: $states.result or $states.errorOutput)
Used to specify and transform output from the state.
When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.
parameters?
Type:
{ [string]: any }
(optional, default: No parameters)
Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
queryLanguage?
Type:
Query
(optional, default: JSONPath)
The name of the query language used by the state.
If the state does not contain a queryLanguage
field,
then it will use the query language specified in the top-level queryLanguage
field.
result?
Type:
Result
(optional, default: No injected result)
If given, treat as the result of this operation.
Can be used to inject or replace the current execution state.
resultPath?
Type:
string
(optional, default: $)
JSONPath expression to indicate where to inject the state's output.
May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
Properties
Name | Type | Description |
---|---|---|
end | INextable [] | Continuable states of this Chainable. |
id | string | Descriptive identifier for this chainable. |
node | Node | The tree node. |
start | State | First state of this Chainable. |
state | string | Tokenized string that evaluates to the state's ID. |
endStates
Type:
INextable
[]
Continuable states of this Chainable.
id
Type:
string
Descriptive identifier for this chainable.
node
Type:
Node
The tree node.
startState
Type:
State
First state of this Chainable.
stateId
Type:
string
Tokenized string that evaluates to the state's ID.
Methods
Name | Description |
---|---|
add | Add a prefix to the stateId of this state. |
bind | Register this state as part of the given graph. |
next(next) | Continue normal execution with the given state. |
to | Return the Amazon States Language object for this state. |
to | Returns a string representation of this construct. |
static json | Define a Pass using JSONPath in the state machine. |
static jsonata(scope, id, props?) | Define a Pass using JSONata in the state machine. |
addPrefix(x)
public addPrefix(x: string): void
Parameters
- x
string
Add a prefix to the stateId of this state.
bindToGraph(graph)
public bindToGraph(graph: StateGraph): void
Parameters
- graph
State
Graph
Register this state as part of the given graph.
Don't call this. It will be called automatically when you work with states normally.
next(next)
public next(next: IChainable): Chain
Parameters
- next
IChainable
Returns
Continue normal execution with the given state.
toStateJson(topLevelQueryLanguage?)
public toStateJson(topLevelQueryLanguage?: QueryLanguage): json
Parameters
- topLevelQueryLanguage
Query
Language
Returns
json
Return the Amazon States Language object for this state.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
static jsonPath(scope, id, props?)
public static jsonPath(scope: Construct, id: string, props?: PassJsonPathProps): Pass
Parameters
- scope
Construct
- id
string
- props
Pass
Json Path Props
Returns
Define a Pass using JSONPath in the state machine.
A Pass state can be used to transform the current execution's state.
static jsonata(scope, id, props?)
public static jsonata(scope: Construct, id: string, props?: PassJsonataProps): Pass
Parameters
- scope
Construct
- id
string
- props
Pass
Jsonata Props
Returns
Define a Pass using JSONata in the state machine.
A Pass state can be used to transform the current execution's state.