interface FailJsonataProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.FailJsonataProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#FailJsonataProps
Java	software.amazon.awscdk.services.stepfunctions.FailJsonataProps
Python	aws_cdk.aws_stepfunctions.FailJsonataProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » FailJsonataProps

Properties for defining a Fail state that using JSONata.

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

Properties

Name	Type	Description
cause?	string	A description for the cause of the failure.
comment?	string	A comment describing this state.
error?	string	Error code used to represent this failure.
queryLanguage?	QueryLanguage	The name of the query language used by the state.
stateName?	string	Optional name for this state.

---

cause?

Type: string (optional, default: No description)

A description for the cause of the failure.

---

comment?

Type: string (optional, default: No comment)

A comment describing this state.

---

error?

Type: string (optional, default: No error code)

Error code used to represent this failure.

---

queryLanguage?

Type: QueryLanguage (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.