interface SingleStateOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.SingleStateOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#SingleStateOptions |
![]() | software.amazon.awscdk.services.stepfunctions.SingleStateOptions |
![]() | aws_cdk.aws_stepfunctions.SingleStateOptions |
![]() | aws-cdk-lib » aws_stepfunctions » SingleStateOptions |
Options for creating a single state.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
declare const arguments_: any;
declare const assign: any;
declare const outputs: any;
declare const resultSelector: any;
const singleStateOptions: stepfunctions.SingleStateOptions = {
arguments: {
argumentsKey: arguments_,
},
assign: {
assignKey: assign,
},
comment: 'comment',
inputPath: 'inputPath',
outputPath: 'outputPath',
outputs: outputs,
prefixStates: 'prefixStates',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
resultPath: 'resultPath',
resultSelector: {
resultSelectorKey: resultSelector,
},
stateId: 'stateId',
stateName: 'stateName',
};
Properties
Name | Type | Description |
---|---|---|
arguments? | { [string]: any } | Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input. |
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. |
prefix | string | String to prefix all stateIds in the state machine with. |
query | Query | The name of the query language used by the state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
state | string | ID of newly created containing state. |
state | string | Optional name for this state. |
arguments?
Type:
{ [string]: any }
(optional, default: No arguments)
Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
See also: https://docs.aws.amazon.com/step-functions/latest/dg/transforming-data.html
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.
prefixStates?
Type:
string
(optional, default: stateId)
String to prefix all stateIds in the state machine with.
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.
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.
resultSelector?
Type:
{ [string]: any }
(optional, default: None)
The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.
stateId?
Type:
string
(optional, default: Construct ID of the StateMachineFragment)
ID of newly created containing state.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.