interface SucceedProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.SucceedProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#SucceedProps |
![]() | software.amazon.awscdk.services.stepfunctions.SucceedProps |
![]() | aws_cdk.aws_stepfunctions.SucceedProps |
![]() | aws-cdk-lib » aws_stepfunctions » SucceedProps |
Properties for defining a Succeed 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 outputs: any;
const succeedProps: stepfunctions.SucceedProps = {
comment: 'comment',
inputPath: 'inputPath',
outputPath: 'outputPath',
outputs: outputs,
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
stateName: 'stateName',
};
Properties
Name | Type | Description |
---|---|---|
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. |
query | Query | The name of the query language used by the state. |
state | string | Optional name for this state. |
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.
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.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.