Class AttiniManualApproval

The manual approval step will pause the deployment plan and wait for confirmation before continuing. The deployment can be resumed by running the "attini deploy continue" command with the Attini CLI.

Hierarchy (view full)

Constructors

constructor

Properties

_next? branches comment? defaultChoice? endStates inputPath? iteration? node outputPath? parameters? resultPath? resultSelector? startState type

Accessors

id stateId

Methods

_addCatch _addRetry addBranch addChoice addIterator addPrefix bindToGraph getOutput getOutputPath makeDefault makeNext next renderBranches renderChoices renderInputOutput renderIterator renderNextEnd renderProps renderResultSelector renderRetryCatch toStateJson toString validateState whenBoundToGraph filterNextables findReachableEndStates findReachableStates isConstruct prefixStates

Constructors

constructor

Properties

Protected Optional Internal _next

_next?: State

Protected Readonly branches

branches: StateGraph[]

Stability

stable

Protected Optional Readonly comment

comment?: string

Stability

stable

Protected Optional defaultChoice

defaultChoice?: State

Stability

stable

Readonly endStates

endStates: INextable[]

Protected Optional Readonly inputPath

inputPath?: string

Stability

stable

Protected Optional iteration

iteration?: StateGraph

Stability

stable

Readonly node

node: Node

The tree node.

Stability

stable

Protected Optional Readonly outputPath

outputPath?: string

Stability

stable

Protected Optional Readonly parameters

parameters?: object

Stability

stable

Protected Optional Readonly resultPath

resultPath?: string

Stability

stable

Protected Optional Readonly resultSelector

resultSelector?: object

Stability

stable

Readonly startState

startState: State

First state of this Chainable.

Stability

stable

type

type: string = 'AttiniManualApproval'

Accessors

id

  • get id(): string

  • Descriptive identifier for this chainable.

    Returns string

    Stability

    stable

stateId

  • get stateId(): string

  • Tokenized string that evaluates to the state's ID.

    Returns string

    Stability

    stable

Methods

Protected _addCatch

  • _addCatch(handler, props?): void
  • Internal

    Add an error handler to the catch list of this state

    Parameters

    • handler: State
    • Optional props: CatchProps

    Returns void

Protected _addRetry

  • _addRetry(props?): void
  • Internal

    Add a retrier to the retry list of this state

    Parameters

    • Optional props: RetryProps

    Returns void

Protected addBranch

  • addBranch(branch): void

  • Add a paralle branch to this state.

    Parameters

    • branch: StateGraph

    Returns void

    Stability

    stable

Protected addChoice

  • addChoice(condition, next): void

  • Add a choice branch to this state.

    Parameters

    • condition: Condition
    • next: State

    Returns void

    Stability

    stable

Protected addIterator

  • addIterator(iteration): void

  • Add a map iterator to this state.

    Parameters

    • iteration: StateGraph

    Returns void

    Stability

    stable

addPrefix

  • addPrefix(x): void

  • Add a prefix to the stateId of this state.

    Parameters

    • x: string

    Returns void

    Stability

    stable

bindToGraph

  • bindToGraph(graph): void

  • 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

getOutput

  • getOutput(...paths?): string

  • Get a string value from the steps output. This method can only be used as the value for a key/value pair in another Attini or StepFunction step.

    Parameters

    • Optional Rest ...paths: string[]

      The path to the value from the outputs root.

    Returns string

    Example

    Valid examples:

    {my-key: step.getOutput()}
    {my-key: step.getOutput('path','to','key')}

    Invalid examples:

    {my-key: 'test'+ step.getOutput()}
    {my-key: '[step.getOutput()]}

getOutputPath

  • getOutputPath(...paths?): string

  • Get the json path to this steps output. Convenience method that will return a string with the following format $.output...

    Parameters

    • Optional Rest ...paths: string[]

      The path to the value from the outputs root.

    Returns string

Protected makeDefault

  • makeDefault(def): void

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

    Parameters

    • def: State

    Returns void

    Stability

    stable

Protected makeNext

  • makeNext(next): void

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

    Parameters

    • next: State

    Returns void

    Stability

    stable

next

Protected renderBranches

  • renderBranches(): any

  • Render parallel branches in ASL JSON format.

    Returns any

    Stability

    stable

Protected renderChoices

  • renderChoices(): any

  • Render the choices in ASL JSON format.

    Returns any

    Stability

    stable

Protected renderInputOutput

  • renderInputOutput(): any

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

    Returns any

    Stability

    stable

Protected renderIterator

  • renderIterator(): any

  • Render map iterator in ASL JSON format.

    Returns any

    Stability

    stable

Protected renderNextEnd

  • renderNextEnd(): any

  • Render the default next state in ASL JSON format.

    Returns any

    Stability

    stable

Protected renderProps

Protected renderResultSelector

  • renderResultSelector(): any

  • Render ResultSelector in ASL JSON format.

    Returns any

    Stability

    stable

Protected renderRetryCatch

  • renderRetryCatch(): any

  • Render error recovery options in ASL JSON format.

    Returns any

    Stability

    stable

toStateJson

toString

  • toString(): string

  • Returns a string representation of this construct.

    Returns string

    Stability

    stable

Protected validateState

  • validateState(): string[]

  • Allows the state to validate itself.

    Returns string[]

    Stability

    stable

Protected whenBoundToGraph

  • whenBoundToGraph(graph): void

  • Called whenever this state is bound to a graph.

    Can be overridden by subclasses.

    Parameters

    • graph: StateGraph

    Returns void

    Stability

    stable

Static filterNextables

  • filterNextables(states): INextable[]

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

    Parameters

    • states: State[]

    Returns INextable[]

    Stability

    stable

Static findReachableEndStates

  • findReachableEndStates(start, options?): State[]

  • 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

Static findReachableStates

  • findReachableStates(start, options?): State[]

  • 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

Static isConstruct

  • isConstruct(x): x is Construct

  • (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

Static prefixStates

  • prefixStates(root, prefix): void

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

    Parameters

    • root: IConstruct
    • prefix: string

    Returns void

    Stability

    stable

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc