interface PassProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.PassProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#PassProps |
![]() | software.amazon.awscdk.services.stepfunctions.PassProps |
![]() | aws_cdk.aws_stepfunctions.PassProps |
![]() | aws-cdk-lib » aws_stepfunctions » PassProps |
Properties for defining a Pass state.
Example
// JSONata Pattern
sfn.Pass.jsonata(this, 'JSONata Pattern', {
outputs: { foo: 'bar' },
// The outputPath does not exist in the props type
// outputPath: '$.status',
});
// JSONPath Pattern
sfn.Pass.jsonPath(this, 'JSONPath Pattern', {
// The outputs does not exist in the props type
// outputs: { foo: 'bar' },
outputPath: '$.status',
});
// Constructor (Legacy) Pattern
new sfn.Pass(this, 'Constructor Pattern', {
queryLanguage: sfn.QueryLanguage.JSONATA, // or JSON_PATH
// Both outputs and outputPath exist as prop types.
outputs: { foo: 'bar' }, // For JSONata
// or
outputPath: '$.status', // For JSONPath
});
Properties
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.