FailJsonPathProps Struct
Properties for defining a Fail state that using JSONPath.
| Source | aws-stepfunctions/lib/states/fail.ts |
|---|---|
| Type last changed |
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 failJsonPathProps: stepfunctions.FailJsonPathProps = {
cause: 'cause',
causePath: 'causePath',
comment: 'comment',
error: 'error',
errorPath: 'errorPath',
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
stateName: 'stateName',
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions
fail_json_path_props = stepfunctions.FailJsonPathProps(
cause="cause",
cause_path="causePath",
comment="comment",
error="error",
error_path="errorPath",
query_language=stepfunctions.QueryLanguage.JSON_PATH,
state_name="stateName"
)
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.stepfunctions.*;
FailJsonPathProps failJsonPathProps = FailJsonPathProps.builder()
.cause("cause")
.causePath("causePath")
.comment("comment")
.error("error")
.errorPath("errorPath")
.queryLanguage(QueryLanguage.JSON_PATH)
.stateName("stateName")
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;
var failJsonPathProps = new FailJsonPathProps {
Cause = "cause",
CausePath = "causePath",
Comment = "comment",
Error = "error",
ErrorPath = "errorPath",
QueryLanguage = QueryLanguage.JSON_PATH,
StateName = "stateName"
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
failJsonPathProps := &FailJsonPathProps{
Cause: jsii.String("cause"),
CausePath: jsii.String("causePath"),
Comment: jsii.String("comment"),
Error: jsii.String("error"),
ErrorPath: jsii.String("errorPath"),
QueryLanguage: awscdk.Aws_stepfunctions.QueryLanguage_JSON_PATH,
StateName: jsii.String("stateName"),
}
Properties
Default: No description
causePathoptionalstringcause_pathoptionalstrcausePathoptionalStringCausePathoptionalstringCausePathoptional*string #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 #Default: No comment
Default: No error code
errorPathoptionalstringerror_pathoptionalstrerrorPathoptionalStringErrorPathoptionalstringErrorPathoptional*string #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 #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 #Default: The construct ID will be used as state name