Package software.amazon.awscdk.services.stepfunctions

Interface DistributedMapProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, MapBaseProps

All Known Implementing Classes:

DistributedMapProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:24.312Z")
@Stability(Stable)
public interface DistributedMapProps
extends software.amazon.jsii.JsiiSerializable, MapBaseProps

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"));
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	DistributedMapProps.Builder	A builder for DistributedMapProps
static final class	DistributedMapProps.Jsii$Proxy	An implementation for DistributedMapProps

Method Summary

Modifier and Type	Method	Description
static DistributedMapProps.Builder	builder()
default ItemBatcher	getItemBatcher()	Specifies to process a group of items in a single child workflow execution.
default IItemReader	getItemReader()	ItemReader.
default String	getLabel()	Label.
default StateMachineType	getMapExecutionType()	MapExecutionType.
default ResultWriter	getResultWriter()	Configuration for S3 location in which to save Map Run results.
default Number	getToleratedFailureCount()	ToleratedFailureCount.
default String	getToleratedFailureCountPath()	ToleratedFailureCountPath.
default Number	getToleratedFailurePercentage()	ToleratedFailurePercentage.
default String	getToleratedFailurePercentagePath()	ToleratedFailurePercentagePath.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.MapBaseProps

getComment, getInputPath, getItemSelector, getItemsPath, getMaxConcurrency, getMaxConcurrencyPath, getOutputPath, getResultPath, getResultSelector, getStateName

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(Stable)
@Nullable
default ResultWriter getResultWriter()

Configuration for S3 location in which to save Map Run results.

Default: - No resultWriter

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