Interface IDistributedMapProps

Properties for configuring a Distribute Map state.

Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IDistributedMapProps : IMapBaseProps
Syntax (vb)
Public Interface IDistributedMapProps
    Inherits IMapBaseProps
Remarks

ExampleMetadata: infused

Examples
/**
 * JSON state input:
 *  {
 *    "bucketName": "my-bucket",
 *    "prefix": "item"
 *  }
 */
var distributedMap = new DistributedMap(this, "DistributedMap", new DistributedMapProps {
    ItemReader = new S3ObjectsItemReader(new S3ObjectsItemReaderProps {
        BucketNamePath = JsonPath.StringAt("$.bucketName"),
        Prefix = JsonPath.StringAt("$.prefix")
    })
});
distributedMap.ItemProcessor(new Pass(this, "Pass"));

Synopsis

Properties

ItemBatcher

Specifies to process a group of items in a single child workflow execution.
ItemReader

ItemReader.
Label

Label.
MapExecutionType

MapExecutionType.
ResultWriter

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

ToleratedFailureCount.
ToleratedFailureCountPath

ToleratedFailureCountPath.
ToleratedFailurePercentage

ToleratedFailurePercentage.
ToleratedFailurePercentagePath

ToleratedFailurePercentagePath.

Properties

ItemBatcher

Specifies to process a group of items in a single child workflow execution.

virtual ItemBatcher ItemBatcher { get; }
Property Value

ItemBatcher

Remarks

Default: - No itemBatcher

ItemReader

ItemReader.

virtual IItemReader ItemReader { get; }
Property Value

IItemReader

Remarks

Configuration for where to read items dataset in S3 to iterate

Default: - No itemReader

Label

Label.

virtual string Label { get; }
Property Value

System.String

Remarks

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

Default: - No label

MapExecutionType

MapExecutionType.

virtual Nullable<StateMachineType> MapExecutionType { get; }
Property Value

System.Nullable<StateMachineType>

Remarks

The execution type of the distributed map state

This property overwrites ProcessorConfig.executionType

Default: StateMachineType.STANDARD

ResultWriter

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

virtual ResultWriter ResultWriter { get; }
Property Value

ResultWriter

Remarks

Default: - No resultWriter

ToleratedFailureCount

ToleratedFailureCount.

virtual Nullable<double> ToleratedFailureCount { get; }
Property Value

System.Nullable<System.Double>

Remarks

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

Default: - No toleratedFailureCount

ToleratedFailureCountPath

ToleratedFailureCountPath.

virtual string ToleratedFailureCountPath { get; }
Property Value

System.String

Remarks

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

Default: - No toleratedFailureCountPath

ToleratedFailurePercentage

ToleratedFailurePercentage.

virtual Nullable<double> ToleratedFailurePercentage { get; }
Property Value

System.Nullable<System.Double>

Remarks

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

Default: - No toleratedFailurePercentage

ToleratedFailurePercentagePath

ToleratedFailurePercentagePath.

virtual string ToleratedFailurePercentagePath { get; }
Property Value

System.String

Remarks

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

Default: - No toleratedFailurePercentagePath