MapProps¶

class aws_cdk.aws_stepfunctions.MapProps(*, comment=None, input_path=None, items_path=None, max_concurrency=None, output_path=None, parameters=None, result_path=None, result_selector=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: $
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
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: $
parameters (Optional[Mapping[str, Any]]) – The JSON that you want to override your default iteration input. 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

ExampleMetadata

infused

Example:

map = sfn.Map(self, "Map State",
    max_concurrency=1,
    items_path=sfn.JsonPath.string_at("$.inputForMap")
)
map.iterator(sfn.Pass(self, "Pass State"))

Attributes

comment¶

An optional description for this state.

Default: No comment
Return type: Optional[str]

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: $
Return type: Optional[str]

items_path¶

JSONPath expression to select the array to iterate over.

Default: $
Return type: Optional[str]

max_concurrency¶

MaxConcurrency.

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

Default

full concurrency

Return type

Union[int, float, None]

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: $
Return type: Optional[str]

parameters¶

The JSON that you want to override your default iteration input.

Default: $
Return type: Optional[Mapping[str, Any]]

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: $
Return type: Optional[str]

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

Return type

Optional[Mapping[str, Any]]