Interface IDistributedMapProps

public interface IDistributedMapProps : IMapBaseProps, IStateBaseProps, IMapBaseOptions, IAssignableStateOptions, IMapBaseJsonPathOptions, IJsonPathCommonOptions, IMapBaseJsonataOptions, IJsonataCommonOptions

Syntax (vb)

Public Interface IDistributedMapProps Inherits IMapBaseProps, IStateBaseProps, IMapBaseOptions, IAssignableStateOptions, IMapBaseJsonPathOptions, IJsonPathCommonOptions, IMapBaseJsonataOptions, IJsonataCommonOptions

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	(deprecated) Configuration for S3 location in which to save Map Run results.
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);
ToleratedFailureCount	ToleratedFailureCount.
ToleratedFailureCountPath	ToleratedFailureCountPath.
ToleratedFailurePercentage	ToleratedFailurePercentage.
ToleratedFailurePercentagePath	ToleratedFailurePercentagePath.

Properties

ItemBatcher

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

ItemBatcher? ItemBatcher { get; }

Property Value

ItemBatcher

Remarks

Default: - No itemBatcher

ItemReader

ItemReader.

IItemReader? ItemReader { get; }

Property Value

IItemReader

Remarks

Configuration for where to read items dataset in S3 to iterate

Default: - No itemReader

Label

Label.

string? Label { get; }

Property Value

string

Remarks

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

Default: - No label

MapExecutionType

MapExecutionType.

StateMachineType? MapExecutionType { get; }

Property Value

StateMachineType?

Remarks

The execution type of the distributed map state

This property overwrites ProcessorConfig.executionType

Default: StateMachineType.STANDARD

ResultWriter

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

[Obsolete("Use {@link resultWriterV2 }")]
ResultWriter? ResultWriter { get; }

Property Value

ResultWriter

Remarks

Default: - No resultWriter

Stability: Deprecated

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

ResultWriterV2? ResultWriterV2 { get; }

Property Value

ResultWriterV2

Remarks

Default: - No resultWriterV2

ToleratedFailureCount

ToleratedFailureCount.

double? ToleratedFailureCount { get; }

Property Value

double?

Remarks

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

Default: - No toleratedFailureCount

ToleratedFailureCountPath

ToleratedFailureCountPath.

string? ToleratedFailureCountPath { get; }

Property Value

string

Remarks

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

Default: - No toleratedFailureCountPath

ToleratedFailurePercentage

ToleratedFailurePercentage.

double? ToleratedFailurePercentage { get; }

Property Value

double?

Remarks

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

Default: - No toleratedFailurePercentage

ToleratedFailurePercentagePath

ToleratedFailurePercentagePath.

string? ToleratedFailurePercentagePath { get; }

Property Value

string

Remarks

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

Default: - No toleratedFailurePercentagePath