DistributedMapProps
- class aws_cdk.aws_stepfunctions.DistributedMapProps(*, 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, item_batcher=None, item_reader=None, label=None, map_execution_type=None, result_writer=None, tolerated_failure_count=None, tolerated_failure_count_path=None, tolerated_failure_percentage=None, tolerated_failure_percentage_path=None)
Bases:
MapBaseProps
Properties for configuring a Distribute Map state.
- Parameters:
comment (
Optional
[str
]) – An optional description for this state. Default: No commentinput_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 withparameters
). 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 concurrencymax_concurrency_path (
Optional
[str
]) – MaxConcurrencyPath. A JsonPath that specifies the maximum concurrency dynamically from the state input. Default: - full concurrencyoutput_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: - Nonestate_name (
Optional
[str
]) – Optional name for this state. Default: - The construct ID will be used as state nameitem_batcher (
Optional
[ItemBatcher
]) – Specifies to process a group of items in a single child workflow execution. Default: - No itemBatcheritem_reader (
Optional
[IItemReader
]) – ItemReader. Configuration for where to read items dataset in S3 to iterate Default: - No itemReaderlabel (
Optional
[str
]) – Label. Unique name for the Distributed Map state added to each Map Run Default: - No labelmap_execution_type (
Optional
[StateMachineType
]) – MapExecutionType. The execution type of the distributed map state This property overwrites ProcessorConfig.executionType Default: StateMachineType.STANDARDresult_writer (
Optional
[ResultWriter
]) – Configuration for S3 location in which to save Map Run results. Default: - No resultWritertolerated_failure_count (
Union
[int
,float
,None
]) – ToleratedFailureCount. Number of failed items to tolerate in a Map Run, as static number Default: - No toleratedFailureCounttolerated_failure_count_path (
Optional
[str
]) – ToleratedFailureCountPath. Number of failed items to tolerate in a Map Run, as JsonPath Default: - No toleratedFailureCountPathtolerated_failure_percentage (
Union
[int
,float
,None
]) – ToleratedFailurePercentage. Percentage of failed items to tolerate in a Map Run, as static number Default: - No toleratedFailurePercentagetolerated_failure_percentage_path (
Optional
[str
]) – ToleratedFailurePercentagePath. Percentage of failed items to tolerate in a Map Run, as JsonPath Default: - No toleratedFailurePercentagePath
- ExampleMetadata:
infused
Example:
distributed_map = sfn.DistributedMap(self, "DistributedMap", map_execution_type=sfn.StateMachineType.EXPRESS ) distributed_map.item_processor(sfn.Pass(self, "Pass"), mode=sfn.ProcessorMode.DISTRIBUTED, execution_type=sfn.ProcessorType.STANDARD )
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_batcher
Specifies to process a group of items in a single child workflow execution.
- Default:
No itemBatcher
- item_reader
ItemReader.
Configuration for where to read items dataset in S3 to iterate
- Default:
No itemReader
- item_selector
The JSON that you want to override your default iteration input (mutually exclusive with
parameters
).
- items_path
JSONPath expression to select the array to iterate over.
- Default:
$
- label
Label.
Unique name for the Distributed Map state added to each Map Run
- Default:
No label
- map_execution_type
MapExecutionType.
The execution type of the distributed map state
This property overwrites ProcessorConfig.executionType
- Default:
StateMachineType.STANDARD
- max_concurrency
MaxConcurrency.
An upper bound on the number of iterations you want running at once.
- max_concurrency_path
MaxConcurrencyPath.
A JsonPath that specifies the maximum concurrency dynamically from the state input.
- 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.
- result_writer
Configuration for S3 location in which to save Map Run results.
- Default:
No resultWriter
- state_name
Optional name for this state.
- Default:
The construct ID will be used as state name
- tolerated_failure_count
ToleratedFailureCount.
Number of failed items to tolerate in a Map Run, as static number
- Default:
No toleratedFailureCount
- tolerated_failure_count_path
ToleratedFailureCountPath.
Number of failed items to tolerate in a Map Run, as JsonPath
- Default:
No toleratedFailureCountPath
- tolerated_failure_percentage
ToleratedFailurePercentage.
Percentage of failed items to tolerate in a Map Run, as static number
- Default:
No toleratedFailurePercentage
- tolerated_failure_percentage_path
ToleratedFailurePercentagePath.
Percentage of failed items to tolerate in a Map Run, as JsonPath
- Default:
No toleratedFailurePercentagePath