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
Distributed
, 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.
Initializer
new MapBase(scope: Construct, id: string, props?: MapBaseProps)
Parameters
- scope
Construct
- id
string
— Descriptive identifier for this chainable. - props
Map
Base Props
Properties
Name | Type | Description |
---|---|---|
end | INextable [] | Continuable states of this Chainable. |
id | string | Descriptive identifier for this chainable. |
node | Node | The tree node. |
start | State | First state of this Chainable. |
state | string | Tokenized string that evaluates to the state's ID. |
item | { [string]: any } | |
items | 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)
itemsPath?
Type:
string
(optional)
Methods
Name | Description |
---|---|
add | Add a prefix to the stateId of this state. |
bind | Register this state as part of the given graph. |
next(next) | Continue normal execution with the given state. |
to | Return the Amazon States Language object for this state. |
to | Returns a string representation of this construct. |
protected validate | Validate this state. |
Prefix(x)
addpublic addPrefix(x: string): void
Parameters
- x
string
Add a prefix to the stateId of this state.
ToGraph(graph)
bindpublic bindToGraph(graph: StateGraph): void
Parameters
- graph
State
Graph
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
Continue normal execution with the given state.
StateJson()
topublic toStateJson(): json
Returns
json
Return the Amazon States Language object for this state.
String()
topublic toString(): string
Returns
string
Returns a string representation of this construct.
State()
protected validateprotected validateState(): string[]
Returns
string[]
Validate this state.