GradientEdge CDK Utils
    Preparing search index...

    Interface SfnSucceedProps

    interface SfnSucceedProps {
        comment?: string;
        inputPath?: string;
        name: string;
        outputPath?: string;
        outputs?: any;
        queryLanguage?: QueryLanguage;
        stateName?: string;
    }

    Hierarchy

    • SucceedProps
      • SfnSucceedProps
    Index

    Properties

    comment? inputPath? name outputPath? outputs? queryLanguage? stateName?

    Properties

    comment?: string

    A comment describing this state

    No comment
    inputPath?: string

    JSONPath expression to select part of the state to be the input to this state.

    May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

    $
    name: string
    outputPath?: string

    JSONPath expression to select part of the state to be the output to this state.

    May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

    $
    outputs?: any

    Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

    https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

    - $states.result or $states.errorOutput
    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