MapBaseProps

class aws_cdk.aws_stepfunctions.MapBaseProps(*, comment=None, input_path=None, item_selector=None, items_path=None, max_concurrency=None, max_concurrency_path=None, output_path=None, result_path=None, result_selector=None, state_name=None)

Bases: object

Properties for defining a Map state.

Parameters:

  • comment (Optional[str]) – An optional description for this state. Default: No comment

  • input_path (Optional[str]) – 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 {}. Default: $

  • item_selector (Optional[Mapping[str, Any]]) – The JSON that you want to override your default iteration input (mutually exclusive with parameters). Default: $

  • items_path (Optional[str]) – JSONPath expression to select the array to iterate over. Default: $

  • max_concurrency (Union[int, float, None]) – MaxConcurrency. An upper bound on the number of iterations you want running at once. Default: - full concurrency

  • max_concurrency_path (Optional[str]) – MaxConcurrencyPath. A JsonPath that specifies the maximum concurrency dynamically from the state input. Default: - full concurrency

  • output_path (Optional[str]) – 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 {}. Default: $

  • result_path (Optional[str]) – 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. Default: $

  • result_selector (Optional[Mapping[str, 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. Default: - None

  • state_name (Optional[str]) – Optional name for this state. Default: - The construct ID will be used as state name

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

# item_selector: Any
# result_selector: Any

map_base_props = stepfunctions.MapBaseProps(
    comment="comment",
    input_path="inputPath",
    item_selector={
        "item_selector_key": item_selector
    },
    items_path="itemsPath",
    max_concurrency=123,
    max_concurrency_path="maxConcurrencyPath",
    output_path="outputPath",
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    state_name="stateName"
)

Attributes

comment

An optional description for this state.

Default:

No comment

input_path

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 {}.

Default:

$

item_selector

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

Default:

$

See:

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

items_path

JSONPath expression to select the array to iterate over.

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

max_concurrency_path

MaxConcurrencyPath.

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

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

output_path

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 {}.

Default:

$

result_path

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.

Default:

$

result_selector

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.

Default:

  • None

See:

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

state_name

Optional name for this state.

Default:

  • The construct ID will be used as state name