AWS CDK Reference

Appearance

v2.274.0

FailJsonataProps Struct ​

Properties for defining a Fail state that using JSONata.

Source
aws-stepfunctions/lib/states/fail.ts
Type last changed
v2.178.0 · 6 Feb 2025

Example ​

ts
// 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';
const failJsonataProps: stepfunctions.FailJsonataProps = {
  cause: 'cause',
  comment: 'comment',
  error: 'error',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  stateName: 'stateName',
};

Properties ​

causeoptionalstringcauseoptionalstrcauseoptionalStringCauseoptionalstringCauseoptional*string#
A description for the cause of the failure.

Default: No description

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#
A comment describing this state.

Default: No comment

erroroptionalstringerroroptionalstrerroroptionalStringErroroptionalstringErroroptional*string#
Error code used to represent this failure.

Default: No error code

queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= 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.

stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#
Optional name for this state.

Default: The construct ID will be used as state name