class MapBase

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.MapBase
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#MapBase
Java	software.amazon.awscdk.services.stepfunctions.MapBase
Python	aws_cdk.aws_stepfunctions.MapBase
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » MapBase

Implements IConstruct, IDependable, IChainable, INextable

Extends State

Implemented by DistributedMap, Map

Define a Map state in the state machine.

A Map state can be used to run a set of steps for each element of an input array. A Map state will execute the same steps for multiple entries of an array in the state input.

While the Parallel state executes multiple branches of steps using the same input, a Map state will execute the same steps for multiple entries of an array in the state input.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html

Initializer

new MapBase(scope: Construct, id: string, props?: MapBaseProps)

Parameters

• scope Construct
• id string — Descriptive identifier for this chainable.
• props MapBaseProps

Properties

Name	Type	Description
endStates	INextable[]	Continuable states of this Chainable.
id	string	Descriptive identifier for this chainable.
node	Node	The tree node.
startState	State	First state of this Chainable.
stateId	string	Tokenized string that evaluates to the state's ID.
itemSelector?	{ [string]: any }
items?	ProvideItems
itemsPath?	string
jsonataItemSelector?	string

---

endStates

Type: INextable[]

Continuable states of this Chainable.

---

id

Type: string

Descriptive identifier for this chainable.

---

node

Type: Node

The tree node.

---

startState

Type: State

First state of this Chainable.

---

stateId

Type: string

Tokenized string that evaluates to the state's ID.

---

itemSelector?

Type: { [string]: any } (optional)

---

items?

Type: ProvideItems (optional)

---

itemsPath?

Type: string (optional)

---

jsonataItemSelector?

Type: string (optional)

Methods

Name	Description
addPrefix(x)	Add a prefix to the stateId of this state.
bindToGraph(graph)	Register this state as part of the given graph.
next(next)	Continue normal execution with the given state.
toStateJson(topLevelQueryLanguage?)	Return the Amazon States Language object for this state.
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.
protected validateState()	Validate this state.

---

addPrefix(x)

public addPrefix(x: string): void

Parameters

• x string

Add a prefix to the stateId of this state.

---

bindToGraph(graph)

public bindToGraph(graph: StateGraph): void

Parameters

• graph StateGraph

Register this state as part of the given graph.

Don't call this. It will be called automatically when you work with states normally.

---

next(next)

public next(next: IChainable): Chain

Parameters

• next IChainable

Returns

• Chain

Continue normal execution with the given state.

---

toStateJson(topLevelQueryLanguage?)

public toStateJson(topLevelQueryLanguage?: QueryLanguage): json

Parameters

• topLevelQueryLanguage QueryLanguage

Returns

• json

Return the Amazon States Language object for this state.

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

---

protected validateState()

protected validateState(): string[]

Returns

• string[]

Validate this state.