Class AttiniMerge

Some AWS StepFunction types return a list instead of an object, for example Parallel or Map.

To make the payload easier to work with, the merge step can merge all the data in the list into one object.

Hierarchy (view full)

Constructors

Properties

_next?: State
branches: StateGraph[]

Stability

stable

comment?: string

Stability

stable

defaultChoice?: State

Stability

stable

endStates: INextable[]
inputPath?: string

Stability

stable

iteration?: StateGraph

Stability

stable

node: Node

The tree node.

Stability

stable

outputPath?: string

Stability

stable

parameters?: object

Stability

stable

resultPath?: string

Stability

stable

resultSelector?: object

Stability

stable

startState: State

First state of this Chainable.

Stability

stable

type: string = 'AttiniMergeOutput'

Accessors

  • get id(): string
  • Descriptive identifier for this chainable.

    Returns string

    Stability

    stable

  • get stateId(): string
  • Tokenized string that evaluates to the state's ID.

    Returns string

    Stability

    stable

Methods

  • Internal

    Add an error handler to the catch list of this state

    Parameters

    • handler: State
    • Optional props: CatchProps

    Returns void

  • Internal

    Add a retrier to the retry list of this state

    Parameters

    • Optional props: RetryProps

    Returns void

  • Add a paralle branch to this state.

    Parameters

    • branch: StateGraph

    Returns void

    Stability

    stable

  • Add a choice branch to this state.

    Parameters

    • condition: Condition
    • next: State

    Returns void

    Stability

    stable

  • Add a map iterator to this state.

    Parameters

    • iteration: StateGraph

    Returns void

    Stability

    stable

  • Add a prefix to the stateId of this state.

    Parameters

    • x: string

    Returns void

    Stability

    stable

  • Register this state as part of the given graph.

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

    Parameters

    • graph: StateGraph

    Returns void

    Stability

    stable

  • Make the indicated state the default choice transition of this state.

    Parameters

    • def: State

    Returns void

    Stability

    stable

  • Make the indicated state the default transition of this state.

    Parameters

    • next: State

    Returns void

    Stability

    stable

  • Render parallel branches in ASL JSON format.

    Returns any

    Stability

    stable

  • Render the choices in ASL JSON format.

    Returns any

    Stability

    stable

  • Render InputPath/Parameters/OutputPath in ASL JSON format.

    Returns any

    Stability

    stable

  • Render map iterator in ASL JSON format.

    Returns any

    Stability

    stable

  • Render the default next state in ASL JSON format.

    Returns any

    Stability

    stable

  • Render ResultSelector in ASL JSON format.

    Returns any

    Stability

    stable

  • Render error recovery options in ASL JSON format.

    Returns any

    Stability

    stable

  • Returns a string representation of this construct.

    Returns string

    Stability

    stable

  • Allows the state to validate itself.

    Returns string[]

    Stability

    stable

  • Called whenever this state is bound to a graph.

    Can be overridden by subclasses.

    Parameters

    • graph: StateGraph

    Returns void

    Stability

    stable

  • Return only the states that allow chaining from an array of states.

    Parameters

    • states: State[]

    Returns INextable[]

    Stability

    stable

  • Find the set of end states states reachable through transitions from the given start state.

    Parameters

    • start: State
    • Optional options: FindStateOptions

    Returns State[]

    Stability

    stable

  • Find the set of states reachable through transitions from the given start state.

    This does not retrieve states from within sub-graphs, such as states within a Parallel state's branch.

    Parameters

    • start: State
    • Optional options: FindStateOptions

    Returns State[]

    Stability

    stable

  • (deprecated) Checks if x is a construct.

    Parameters

    • x: any

      Any object.

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

    Deprecated

    use x instanceof Construct instead

  • Add a prefix to the stateId of all States found in a construct tree.

    Parameters

    • root: IConstruct
    • prefix: string

    Returns void

    Stability

    stable

Generated using TypeDoc