Interface DistributedMapJsonataProps
- All Superinterfaces:
AssignableStateOptions
,software.amazon.jsii.JsiiSerializable
,JsonataCommonOptions
,MapBaseJsonataOptions
,MapBaseOptions
,StateBaseProps
- All Known Implementing Classes:
DistributedMapJsonataProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.112.0 (build de1bc80)",
date="2025-06-13T09:19:47.048Z")
@Stability(Stable)
public interface DistributedMapJsonataProps
extends software.amazon.jsii.JsiiSerializable, StateBaseProps, MapBaseOptions, MapBaseJsonataOptions
Properties for configuring a Distribute Map state that using JSONata.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.stepfunctions.*; Object assign; ItemBatcher itemBatcher; IItemReader itemReader; Object itemSelector; Object outputs; ProvideItems provideItems; ResultWriter resultWriter; ResultWriterV2 resultWriterV2; DistributedMapJsonataProps distributedMapJsonataProps = DistributedMapJsonataProps.builder() .assign(Map.of( "assignKey", assign)) .comment("comment") .itemBatcher(itemBatcher) .itemReader(itemReader) .items(provideItems) .itemSelector(Map.of( "itemSelectorKey", itemSelector)) .jsonataItemSelector("jsonataItemSelector") .label("label") .mapExecutionType(StateMachineType.EXPRESS) .maxConcurrency(123) .outputs(outputs) .queryLanguage(QueryLanguage.JSON_PATH) .resultWriter(resultWriter) .resultWriterV2(resultWriterV2) .stateName("stateName") .toleratedFailureCount(123) .toleratedFailurePercentage(123) .build();
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forDistributedMapJsonataProps
static final class
An implementation forDistributedMapJsonataProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default ItemBatcher
Specifies to process a group of items in a single child workflow execution.default IItemReader
ItemReader.default String
getLabel()
Label.default StateMachineType
MapExecutionType.default ResultWriter
Deprecated.default ResultWriterV2
Configuration for S3 location in which to save Map Run results Enable "@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2" feature in the context to use resultWriterV2 Example: stack.node.setContext("@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2", true);default Number
ToleratedFailureCount.default Number
ToleratedFailurePercentage.Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssign
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions
getOutputs
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.MapBaseJsonataOptions
getItems
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.MapBaseOptions
getItemSelector, getJsonataItemSelector, getMaxConcurrency
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateName
-
Method Details
-
getItemBatcher
Specifies to process a group of items in a single child workflow execution.Default: - No itemBatcher
-
getItemReader
ItemReader.Configuration for where to read items dataset in S3 to iterate
Default: - No itemReader
-
getLabel
Label.Unique name for the Distributed Map state added to each Map Run
Default: - No label
-
getMapExecutionType
MapExecutionType.The execution type of the distributed map state
This property overwrites ProcessorConfig.executionType
Default: StateMachineType.STANDARD
-
getResultWriter
Deprecated.Useinvalid reference
resultWriterV2
(deprecated) Configuration for S3 location in which to save Map Run results.Default: - No resultWriter
-
getResultWriterV2
Configuration for S3 location in which to save Map Run results Enable "@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2" feature in the context to use resultWriterV2 Example: stack.node.setContext("@aws-cdk/aws-stepfunctions:useDistributedMapResultWriterV2", true);Default: - No resultWriterV2
-
getToleratedFailureCount
ToleratedFailureCount.Number of failed items to tolerate in a Map Run, as static number
Default: - No toleratedFailureCount
-
getToleratedFailurePercentage
ToleratedFailurePercentage.Percentage of failed items to tolerate in a Map Run, as static number
Default: - No toleratedFailurePercentage
-
builder
- Returns:
- a
DistributedMapJsonataProps.Builder
ofDistributedMapJsonataProps
-
invalid reference