Package software.amazon.awscdk.services.stepfunctions

Interface DistributedMapProps

All Superinterfaces:
AssignableStateOptions, software.amazon.jsii.JsiiSerializable, JsonataCommonOptions, JsonPathCommonOptions, MapBaseJsonataOptions, MapBaseJsonPathOptions, MapBaseOptions, MapBaseProps, StateBaseProps
All Known Implementing Classes:
DistributedMapProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.126.0 (build 206d44b)", date="2026-02-03T13:58:31.932Z") @Stability(Stable) public interface DistributedMapProps extends software.amazon.jsii.JsiiSerializable, MapBaseProps, MapBaseOptions, MapBaseJsonPathOptions, MapBaseJsonataOptions
Properties for configuring a Distribute Map state.

Example: 

 /**
  * JSON state input:
  *  {
  *    "bucketName": "my-bucket",
  *    "prefix": "item"
  *  }
  */
 DistributedMap distributedMap = DistributedMap.Builder.create(this, "DistributedMap")
         .itemReader(S3ObjectsItemReader.Builder.create()
                 .bucketNamePath(JsonPath.stringAt("$.bucketName"))
                 .prefix(JsonPath.stringAt("$.prefix"))
                 .build())
         .build();
 distributedMap.itemProcessor(new Pass(this, "Pass"));

  • Method Details

    • getItemBatcher

      @Stability(Stable) @Nullable default ItemBatcher getItemBatcher()
      Specifies to process a group of items in a single child workflow execution.

      Default: - No itemBatcher

    • getItemReader

      @Stability(Stable) @Nullable default IItemReader getItemReader()
      ItemReader.

      Configuration for where to read items dataset in S3 to iterate

      Default: - No itemReader

    • getLabel

      @Stability(Stable) @Nullable default String getLabel()
      Label.

      Unique name for the Distributed Map state added to each Map Run

      Default: - No label

    • getMapExecutionType

      @Stability(Stable) @Nullable default StateMachineType getMapExecutionType()
      MapExecutionType.

      The execution type of the distributed map state

      This property overwrites ProcessorConfig.executionType

      Default: StateMachineType.STANDARD

    • getResultWriter

      @Stability(Deprecated) @Deprecated @Nullable default ResultWriter getResultWriter()
      Deprecated.
      Use
      invalid reference 
      resultWriterV2
      (deprecated) Configuration for S3 location in which to save Map Run results.

      Default: - No resultWriter

    • getResultWriterV2

      @Stability(Stable) @Nullable default ResultWriterV2 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

      @Stability(Stable) @Nullable default Number getToleratedFailureCount()
      ToleratedFailureCount.

      Number of failed items to tolerate in a Map Run, as static number

      Default: - No toleratedFailureCount

    • getToleratedFailureCountPath

      @Stability(Stable) @Nullable default String getToleratedFailureCountPath()
      ToleratedFailureCountPath.

      Number of failed items to tolerate in a Map Run, as JsonPath

      Default: - No toleratedFailureCountPath

    • getToleratedFailurePercentage

      @Stability(Stable) @Nullable default Number getToleratedFailurePercentage()
      ToleratedFailurePercentage.

      Percentage of failed items to tolerate in a Map Run, as static number

      Default: - No toleratedFailurePercentage

    • getToleratedFailurePercentagePath

      @Stability(Stable) @Nullable default String getToleratedFailurePercentagePath()
      ToleratedFailurePercentagePath.

      Percentage of failed items to tolerate in a Map Run, as JsonPath

      Default: - No toleratedFailurePercentagePath

    • builder

      @Stability(Stable) static DistributedMapProps.Builder builder()
      Returns:
      a DistributedMapProps.Builder of DistributedMapProps