GradientEdge CDK Utils
    Preparing search index...

    Interface SfnMapProps

    interface SfnMapProps {
        assign?: { [name: string]: any };
        comment?: string;
        inputPath?: string;
        items?: ProvideItems;
        itemSelector?: { [key: string]: any };
        itemsPath?: string;
        jsonataItemSelector?: string;
        jsonataMaxConcurrency?: string;
        maxConcurrency?: number;
        maxConcurrencyPath?: string;
        outputPath?: string;
        outputs?: any;
        parameters?: { [key: string]: any };
        queryLanguage?: QueryLanguage;
        resultPath?: string;
        resultSelector?: { [key: string]: any };
        stateName?: string;
    }

    Hierarchy

    • MapProps
      • SfnMapProps
    Index

    Properties

    assign? comment? inputPath? items? itemSelector? itemsPath? jsonataItemSelector? jsonataMaxConcurrency? maxConcurrency? maxConcurrencyPath? outputPath? outputs? parameters? queryLanguage? resultPath? resultSelector? stateName?

    Properties

    assign?: { [name: string]: any }

    Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps.

    https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

    - Not assign variables
    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 {}.

    $
    items?: ProvideItems

    The array that the Map state will iterate over.

    - The state input as is.
    itemSelector?: { [key: string]: any }

    The JSON that you want to override your default iteration input (mutually exclusive with parameters and jsonataItemSelector).

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

    $
    itemsPath?: string

    JSONPath expression to select the array to iterate over

    $
    jsonataItemSelector?: string

    Jsonata expression that evaluates to a JSON array to override your default iteration input (mutually exclusive with parameters and itemSelector).

    Example value: {% {\"foo\": \"foo\", \"input\": $states.input} %}

    $
    jsonataMaxConcurrency?: string

    JSONata expression for MaxConcurrency

    A JSONata expression that evaluates to an integer, specifying the maximum concurrency dynamically. Mutually exclusive with maxConcurrency and maxConcurrencyPath.

    Example value: {% $states.input.maxConcurrency %}

    https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

    - full concurrency
    maxConcurrency?: number

    MaxConcurrency

    An upper bound on the number of iterations you want running at once.

    https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

    - full concurrency
    maxConcurrencyPath?: string

    MaxConcurrencyPath

    A JsonPath that specifies the maximum concurrency dynamically from the state input.

    https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

    - full concurrency
    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
    parameters?: { [key: string]: any }

    The JSON that you want to override your default iteration input (mutually exclusive with itemSelector).

    Step Functions has deprecated the parameters field in favor of the new itemSelector field

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

    $
    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
    resultPath?: string

    JSONPath expression to indicate where to inject the state's output

    May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

    $
    resultSelector?: { [key: string]: any }

    The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

    You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

    https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

    - None
    stateName?: string

    Optional name for this state

    - The construct ID will be used as state name

    Settings

    Member Visibility

    On This Page

    Properties