Class DistributedMapProps

Properties for configuring a Distribute Map state.

Inheritance

System.Object

DistributedMapProps

Implements

IDistributedMapProps

IMapBaseProps

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class DistributedMapProps : Object, IDistributedMapProps, IMapBaseProps

Syntax (vb)

Public Class DistributedMapProps
    Inherits Object
    Implements IDistributedMapProps, 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

Constructors

DistributedMapProps()

Properties

Comment	An optional description for this state.
InputPath	JSONPath expression to select part of the state to be the input to this state.
ItemBatcher	Specifies to process a group of items in a single child workflow execution.
ItemReader	ItemReader.
ItemSelector	The JSON that you want to override your default iteration input (mutually exclusive with `parameters`).
ItemsPath	JSONPath expression to select the array to iterate over.
Label	Label.
MapExecutionType	MapExecutionType.
MaxConcurrency	MaxConcurrency.
MaxConcurrencyPath	MaxConcurrencyPath.
OutputPath	JSONPath expression to select part of the state to be the output to this state.
ResultPath	JSONPath expression to indicate where to inject the state's output.
ResultSelector	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
ResultWriter	Configuration for S3 location in which to save Map Run results.
StateName	Optional name for this state.
ToleratedFailureCount	ToleratedFailureCount.
ToleratedFailureCountPath	ToleratedFailureCountPath.
ToleratedFailurePercentage	ToleratedFailurePercentage.
ToleratedFailurePercentagePath	ToleratedFailurePercentagePath.

Constructors

DistributedMapProps()

public DistributedMapProps()

Properties

Comment

An optional description for this state.

public string Comment { get; set; }

Property Value

System.String

Remarks

Default: No comment

InputPath

JSONPath expression to select part of the state to be the input to this state.

public string InputPath { get; set; }

Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: $

ItemBatcher

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

public ItemBatcher ItemBatcher { get; set; }

Property Value

ItemBatcher

Remarks

Default: - No itemBatcher

ItemReader

ItemReader.

public IItemReader ItemReader { get; set; }

Property Value

IItemReader

Remarks

Configuration for where to read items dataset in S3 to iterate

Default: - No itemReader

ItemSelector

The JSON that you want to override your default iteration input (mutually exclusive with parameters).

public IDictionary<string, object> ItemSelector { get; set; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

Default: $

See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-itemselector.html

ItemsPath

JSONPath expression to select the array to iterate over.

public string ItemsPath { get; set; }

Property Value

System.String

Remarks

Default: $

Label

Label.

public string Label { get; set; }

Property Value

System.String

Remarks

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

Default: - No label

MapExecutionType

MapExecutionType.

public Nullable<StateMachineType> MapExecutionType { get; set; }

Property Value

System.Nullable<StateMachineType>

Remarks

The execution type of the distributed map state

This property overwrites ProcessorConfig.executionType

Default: StateMachineType.STANDARD

MaxConcurrency

MaxConcurrency.

public Nullable<double> MaxConcurrency { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

An upper bound on the number of iterations you want running at once.

Default: - full concurrency

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

MaxConcurrencyPath

MaxConcurrencyPath.

public string MaxConcurrencyPath { get; set; }

Property Value

System.String

Remarks

A JsonPath that specifies the maximum concurrency dynamically from the state input.

Default: - full concurrency

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-asl-use-map-state-inline.html#map-state-inline-additional-fields

OutputPath

JSONPath expression to select part of the state to be the output to this state.

public string OutputPath { get; set; }

Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

ResultPath

JSONPath expression to indicate where to inject the state's output.

public string ResultPath { get; set; }

Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: $

ResultSelector

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

public IDictionary<string, object> ResultSelector { get; set; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

ResultWriter

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

public ResultWriter ResultWriter { get; set; }

Property Value

ResultWriter

Remarks

Default: - No resultWriter

StateName

Optional name for this state.

public string StateName { get; set; }

Property Value

System.String

Remarks

Default: - The construct ID will be used as state name

ToleratedFailureCount

ToleratedFailureCount.

public Nullable<double> ToleratedFailureCount { get; set; }

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.

public string ToleratedFailureCountPath { get; set; }

Property Value

System.String

Remarks

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

Default: - No toleratedFailureCountPath

ToleratedFailurePercentage

ToleratedFailurePercentage.

public Nullable<double> ToleratedFailurePercentage { get; set; }

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.

public string ToleratedFailurePercentagePath { get; set; }

Property Value

System.String

Remarks

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

Default: - No toleratedFailurePercentagePath

Implements

IDistributedMapProps

IMapBaseProps