GradientEdge CDK Utils
    Preparing search index...

    Interface SfnFailProps

    interface SfnFailProps {
        cause?: string;
        causePath?: string;
        comment?: string;
        error?: string;
        errorPath?: string;
        name: string;
        queryLanguage?: QueryLanguage;
        stateName?: string;
    }

    Hierarchy

    • FailProps
      • SfnFailProps
    Index

    Properties

    cause? causePath? comment? error? errorPath? name queryLanguage? stateName?

    Properties

    cause?: string

    A description for the cause of the failure

    - No description
    causePath?: string

    JsonPath expression to select part of the state to be the cause to this state.

    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.

    - No cause path
    comment?: string

    A comment describing this state

    No comment
    error?: string

    Error code used to represent this failure

    - No error code
    errorPath?: string

    JsonPath expression to select part of the state to be the error to this state.

    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.

    - No error path
    name: string
    queryLanguage?: QueryLanguage

    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.

    - JSONPath
    stateName?: string

    Optional name for this state

    - The construct ID will be used as state name

    Settings

    Member Visibility

    On This Page

    Properties