Skip to content
v2.277.0

FailProps Struct ​

Properties for defining a Fail state.

Example ​

ts
const fail = new sfn.Fail(this, 'Fail', {
  errorPath: sfn.JsonPath.format('error: {}.', sfn.JsonPath.stringAt('$.someError')),
  causePath: "States.Format('cause: {}.', $.someCause)",
});
python
fail = sfn.Fail(self, "Fail",
    error_path=sfn.JsonPath.format("error: {}.", sfn.JsonPath.string_at("$.someError")),
    cause_path="States.Format('cause: {}.', $.someCause)"
)
java
Fail fail = Fail.Builder.create(this, "Fail")
        .errorPath(JsonPath.format("error: {}.", JsonPath.stringAt("$.someError")))
        .causePath("States.Format('cause: {}.', $.someCause)")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
var fail = new Fail(this, "Fail", new FailProps {
    ErrorPath = JsonPath.Format("error: {}.", JsonPath.StringAt("$.someError")),
    CausePath = "States.Format('cause: {}.', $.someCause)"
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
fail := sfn.NewFail(this, jsii.String("Fail"), &FailProps{
	ErrorPath: sfn.JsonPath_Format(jsii.String("error: {}."), sfn.JsonPath_StringAt(jsii.String("$.someError"))),
	CausePath: jsii.String("States.Format('cause: {}.', $.someCause)"),
})

Properties ​

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

Default: No description

causePathoptionalstringcause_pathoptionalstrcausePathoptionalStringCausePathoptionalstringCausePathoptional*string #
JsonPath expression to select part of the state to be the cause to this state.

Default: No cause path

notes

You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.

commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string #
A comment describing this state.

Default: No comment

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

Default: No error code

errorPathoptionalstringerror_pathoptionalstrerrorPathoptionalStringErrorPathoptionalstringErrorPathoptional*string #
JsonPath expression to select part of the state to be the error to this state.

Default: No error path

notes

You can also use an intrinsic function that returns a string to specify this property. The allowed functions include States.Format, States.JsonToString, States.ArrayGetItem, States.Base64Encode, States.Base64Decode, States.Hash, and States.UUID.

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