Class MapBaseProps

public class MapBaseProps : IMapBaseProps, IStateBaseProps, IMapBaseOptions, IAssignableStateOptions, IMapBaseJsonPathOptions, IJsonPathCommonOptions, IMapBaseJsonataOptions, IJsonataCommonOptions

Syntax (vb)

Public Class MapBaseProps Implements IMapBaseProps, IStateBaseProps, IMapBaseOptions, IAssignableStateOptions, IMapBaseJsonPathOptions, IJsonPathCommonOptions, IMapBaseJsonataOptions, IJsonataCommonOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.StepFunctions;

            var assign;
            var itemSelector;
            var outputs;
            ProvideItems provideItems;
            var resultSelector;

            var mapBaseProps = new MapBaseProps {
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                InputPath = "inputPath",
                Items = provideItems,
                ItemSelector = new Dictionary<string, object> {
                    { "itemSelectorKey", itemSelector }
                },
                ItemsPath = "itemsPath",
                JsonataItemSelector = "jsonataItemSelector",
                MaxConcurrency = 123,
                MaxConcurrencyPath = "maxConcurrencyPath",
                OutputPath = "outputPath",
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                ResultPath = "resultPath",
                ResultSelector = new Dictionary<string, object> {
                    { "resultSelectorKey", resultSelector }
                },
                StateName = "stateName"
            };

Synopsis

Constructors

MapBaseProps()

Properties for defining a Map state.

Properties

Assign	Workflow variables to store in this step.
Comment	A comment describing this state.
InputPath	JSONPath expression to select part of the state to be the input to this state.
ItemSelector	The JSON that you want to override your default iteration input (mutually exclusive with `parameters` and `jsonataItemSelector`).
Items	The array that the Map state will iterate over.
ItemsPath	JSONPath expression to select the array to iterate over.
JsonataItemSelector	Jsonata expression that evaluates to a JSON array to override your default iteration input (mutually exclusive with `parameters` and `itemSelector`).
MaxConcurrency	MaxConcurrency.
MaxConcurrencyPath	MaxConcurrencyPath.
OutputPath	JSONPath expression to select part of the state to be the output to this state.
Outputs	Used to specify and transform output from the state.
QueryLanguage	The name of the query language used by the 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.
StateName	Optional name for this state.

Constructors

MapBaseProps()

Properties for defining a Map state.

public MapBaseProps()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.StepFunctions;

            var assign;
            var itemSelector;
            var outputs;
            ProvideItems provideItems;
            var resultSelector;

            var mapBaseProps = new MapBaseProps {
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                InputPath = "inputPath",
                Items = provideItems,
                ItemSelector = new Dictionary<string, object> {
                    { "itemSelectorKey", itemSelector }
                },
                ItemsPath = "itemsPath",
                JsonataItemSelector = "jsonataItemSelector",
                MaxConcurrency = 123,
                MaxConcurrencyPath = "maxConcurrencyPath",
                OutputPath = "outputPath",
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                ResultPath = "resultPath",
                ResultSelector = new Dictionary<string, object> {
                    { "resultSelectorKey", resultSelector }
                },
                StateName = "stateName"
            };

Properties

Assign

Workflow variables to store in this step.

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

Property Value

IDictionary<string, object>

Remarks

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

See: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

Comment

A comment describing this state.

public string? Comment { get; set; }

Property Value

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

string

Remarks

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

Default: $

ItemSelector

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

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

Property Value

IDictionary<string, object>

Remarks

Default: $

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

Items

The array that the Map state will iterate over.

public ProvideItems? Items { get; set; }

Property Value

ProvideItems

Remarks

Default: - The state input as is.

ItemsPath

JSONPath expression to select the array to iterate over.

public string? ItemsPath { get; set; }

Property Value

string

Remarks

Default: $

JsonataItemSelector

Jsonata expression that evaluates to a JSON array to override your default iteration input (mutually exclusive with parameters and itemSelector).

public string? JsonataItemSelector { get; set; }

Property Value

string

Remarks

Example value: {% {"foo": "foo", "input": $states.input} %}

Default: $

MaxConcurrency

MaxConcurrency.

public double? MaxConcurrency { get; set; }

Property Value

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

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

string

Remarks

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

Default: $

Outputs

Used to specify and transform output from the state.

public object? Outputs { get; set; }

Property Value

object

Remarks

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

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

QueryLanguage

The name of the query language used by the state.

public QueryLanguage? QueryLanguage { get; set; }

Property Value

QueryLanguage?

Remarks

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

ResultPath

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

public string? ResultPath { get; set; }

Property Value

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

IDictionary<string, 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

StateName

Optional name for this state.

public string? StateName { get; set; }

Property Value

string

Remarks

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

Implements

IMapBaseProps

IStateBaseProps

IMapBaseOptions

IAssignableStateOptions

IMapBaseJsonPathOptions

IJsonPathCommonOptions

IMapBaseJsonataOptions

IJsonataCommonOptions