MapJsonataProps

class aws_cdk.aws_stepfunctions.MapJsonataProps(*, comment=None, query_language=None, state_name=None, assign=None, item_selector=None, jsonata_item_selector=None, max_concurrency=None, outputs=None, items=None, parameters=None)

Bases: StateBaseProps, MapBaseOptions, MapBaseJsonataOptions

Properties for defining a Map state that using JSONata.

Parameters:

comment (Optional[str]) – A comment describing this state. Default: No comment
query_language (Optional[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. Default: - JSONPath
state_name (Optional[str]) – Optional name for this state. Default: - The construct ID will be used as state name
assign (Optional[Mapping[str, 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. Default: - Not assign variables
item_selector (Optional[Mapping[str, Any]]) – The JSON that you want to override your default iteration input (mutually exclusive with parameters and jsonataItemSelector). Default: $
jsonata_item_selector (Optional[str]) – 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} %} Default: $
max_concurrency (Union[int, float, None]) – MaxConcurrency. An upper bound on the number of iterations you want running at once. Default: - full concurrency
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. Default: - $states.result or $states.errorOutput
items (Optional[ProvideItems]) – The array that the Map state will iterate over. Default: - The state input as is.
parameters (Optional[Mapping[str, Any]]) – (deprecated) The JSON that you want to override your default iteration input (mutually exclusive with itemSelector). Default: $

ExampleMetadata:

fixture=_generated

Example:

# 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

# assign: Any
# item_selector: Any
# outputs: Any
# parameters: Any
# provide_items: stepfunctions.ProvideItems

map_jsonata_props = stepfunctions.MapJsonataProps(
    assign={
        "assign_key": assign
    },
    comment="comment",
    items=provide_items,
    item_selector={
        "item_selector_key": item_selector
    },
    jsonata_item_selector="jsonataItemSelector",
    max_concurrency=123,
    outputs=outputs,
    parameters={
        "parameters_key": parameters
    },
    query_language=stepfunctions.QueryLanguage.JSON_PATH,
    state_name="stateName"
)

Attributes

assign

Workflow variables to store in this step.

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

Default:

Not assign variables

See:

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

comment

A comment describing this state.

Default:: No comment

item_selector

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

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

items

The array that the Map state will iterate over.

Default:

The state input as is.

jsonata_item_selector

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} %}

Default:: $

max_concurrency

MaxConcurrency.

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

Default:

full concurrency

See:

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

outputs

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.

Default:

$states.result or $states.errorOutput

See:

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

parameters

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

Default:: $
Deprecated:

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

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

query_language

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.

Default:

JSONPath

state_name

Optional name for this state.

Default:

The construct ID will be used as state name