interface DistributedMapProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.DistributedMapProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#DistributedMapProps |
Java | software.amazon.awscdk.services.stepfunctions.DistributedMapProps |
Python | aws_cdk.aws_stepfunctions.DistributedMapProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions » DistributedMapProps |
Properties for configuring a Distribute Map state.
Example
const distributedMap = new sfn.DistributedMap(this, 'Distributed Map State', {
maxConcurrency: 1,
itemsPath: sfn.JsonPath.stringAt('$.inputForMap'),
});
distributedMap.itemProcessor(new sfn.Pass(this, 'Pass State'));
Properties
Name | Type | Description |
---|---|---|
comment? | string | An optional description for this state. |
input | string | JSONPath expression to select part of the state to be the input to this state. |
item | Item | Specifies to process a group of items in a single child workflow execution. |
item | IItem | ItemReader. |
item | { [string]: any } | The JSON that you want to override your default iteration input (mutually exclusive with parameters ). |
items | string | JSONPath expression to select the array to iterate over. |
label? | string | Label. |
map | State | MapExecutionType. |
max | number | MaxConcurrency. |
max | string | MaxConcurrencyPath. |
output | string | JSONPath expression to select part of the state to be the output to this state. |
result | string | JSONPath expression to indicate where to inject the state's output. |
result | { [string]: any } | The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. |
result | Result | Configuration for S3 location in which to save Map Run results. |
state | string | Optional name for this state. |
tolerated | number | ToleratedFailureCount. |
tolerated | string | ToleratedFailureCountPath. |
tolerated | number | ToleratedFailurePercentage. |
tolerated | string | ToleratedFailurePercentagePath. |
comment?
Type:
string
(optional, default: No comment)
An optional description for this state.
inputPath?
Type:
string
(optional, default: $)
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 {}.
itemBatcher?
Type:
Item
(optional, default: No itemBatcher)
Specifies to process a group of items in a single child workflow execution.
itemReader?
Type:
IItem
(optional, default: No itemReader)
ItemReader.
Configuration for where to read items dataset in S3 to iterate
itemSelector?
Type:
{ [string]: any }
(optional, default: $)
The JSON that you want to override your default iteration input (mutually exclusive with parameters
).
See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemselector.html
itemsPath?
Type:
string
(optional, default: $)
JSONPath expression to select the array to iterate over.
label?
Type:
string
(optional, default: No label)
Label.
Unique name for the Distributed Map state added to each Map Run
mapExecutionType?
Type:
State
(optional, default: StateMachineType.STANDARD)
MapExecutionType.
The execution type of the distributed map state
maxConcurrency?
Type:
number
(optional, default: full concurrency)
MaxConcurrency.
An upper bound on the number of iterations you want running at once.
maxConcurrencyPath?
Type:
string
(optional, default: full concurrency)
MaxConcurrencyPath.
A JsonPath that specifies the maximum concurrency dynamically from the state input.
outputPath?
Type:
string
(optional, default: $)
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 {}.
resultPath?
Type:
string
(optional, default: $)
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?
Type:
{ [string]: any }
(optional, default: None)
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.
resultWriter?
Type:
Result
(optional, default: No resultWriter)
Configuration for S3 location in which to save Map Run results.
stateName?
Type:
string
(optional, default: The construct ID will be used as state name)
Optional name for this state.
toleratedFailureCount?
Type:
number
(optional, default: No toleratedFailureCount)
ToleratedFailureCount.
Number of failed items to tolerate in a Map Run, as static number
toleratedFailureCountPath?
Type:
string
(optional, default: No toleratedFailureCountPath)
ToleratedFailureCountPath.
Number of failed items to tolerate in a Map Run, as JsonPath
toleratedFailurePercentage?
Type:
number
(optional, default: No toleratedFailurePercentage)
ToleratedFailurePercentage.
Percentage of failed items to tolerate in a Map Run, as static number
toleratedFailurePercentagePath?
Type:
string
(optional, default: No toleratedFailurePercentagePath)
ToleratedFailurePercentagePath.
Percentage of failed items to tolerate in a Map Run, as JsonPath