Package software.amazon.awscdk.services.stepfunctions

Interface MapBaseProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

DistributedMapProps, MapProps

All Known Implementing Classes:

DistributedMapProps.Jsii$Proxy, MapBaseProps.Jsii$Proxy, MapProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:16.716Z")
@Stability(Stable)
public interface MapBaseProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a Map state.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 Object itemSelector;
 Object resultSelector;
 MapBaseProps mapBaseProps = MapBaseProps.builder()
         .comment("comment")
         .inputPath("inputPath")
         .itemSelector(Map.of(
                 "itemSelectorKey", itemSelector))
         .itemsPath("itemsPath")
         .maxConcurrency(123)
         .maxConcurrencyPath("maxConcurrencyPath")
         .outputPath("outputPath")
         .resultPath("resultPath")
         .resultSelector(Map.of(
                 "resultSelectorKey", resultSelector))
         .stateName("stateName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MapBaseProps.Builder	builder()
default String	getComment()	An optional description for this state.
default String	getInputPath()	JSONPath expression to select part of the state to be the input to this state.
default Map<String,Object>	getItemSelector()	The JSON that you want to override your default iteration input (mutually exclusive with parameters).
default String	getItemsPath()	JSONPath expression to select the array to iterate over.
default Number	getMaxConcurrency()	MaxConcurrency.
default String	getMaxConcurrencyPath()	MaxConcurrencyPath.
default String	getOutputPath()	JSONPath expression to select part of the state to be the output to this state.
default String	getResultPath()	JSONPath expression to indicate where to inject the state's output.
default Map<String,Object>	getResultSelector()	The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
default String	getStateName()	Optional name for this state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComment

@Stability(Stable)
@Nullable
default String getComment()

An optional description for this state.

Default: No comment

getInputPath

@Stability(Stable)
@Nullable
default String getInputPath()

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

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

Default: $

getItemSelector

@Stability(Stable)
@Nullable
default Map<String,Object> getItemSelector()

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

Default: $

See Also:

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

getItemsPath

@Stability(Stable)
@Nullable
default String getItemsPath()

JSONPath expression to select the array to iterate over.

Default: $

getMaxConcurrency

@Stability(Stable)
@Nullable
default Number getMaxConcurrency()

MaxConcurrency.

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

Default: - full concurrency

See Also:

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

getMaxConcurrencyPath

@Stability(Stable)
@Nullable
default String getMaxConcurrencyPath()

MaxConcurrencyPath.

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

Default: - full concurrency

See Also:

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

getOutputPath

@Stability(Stable)
@Nullable
default String getOutputPath()

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

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

Default: $

getResultPath

@Stability(Stable)
@Nullable
default String getResultPath()

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

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

Default: $

getResultSelector

@Stability(Stable)
@Nullable
default Map<String,Object> getResultSelector()

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

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

Default: - None

See Also:

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

getStateName

@Stability(Stable)
@Nullable
default String getStateName()

Optional name for this state.

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

builder

@Stability(Stable)
static MapBaseProps.Builder builder()

Returns:

a MapBaseProps.Builder of MapBaseProps