StateGraph

class aws_cdk.aws_stepfunctions.StateGraph(start_state, graph_description)

Bases: object

A collection of connected states.

A StateGraph is used to keep track of all states that are connected (have transitions between them). It does not include the substatemachines in a Parallel’s branches: those are their own StateGraphs, but the graphs themselves have a hierarchical relationship as well.

By assigning states to a definitive StateGraph, we verify that no state machines are constructed. In particular:

• Every state object can only ever be in 1 StateGraph, and not inadvertently be used in two graphs.

• Every stateId must be unique across all states in the entire state machine.

All policy statements in all states in all substatemachines are bubbled so that the top-level StateMachine instantiation can read them all and add them to the IAM Role.

You do not need to instantiate this class; it is used internally.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions

# state: stepfunctions.State

state_graph = stepfunctions.StateGraph(state, "graphDescription")

Parameters:

• start_state (State) – state that gets executed when the state machine is launched.

• graph_description (str) – description of the state machine.

Methods

bind(state_machine)

Binds this StateGraph to the StateMachine it defines and updates state machine permissions.

Parameters:

state_machine (StateMachine) –

Return type:

None

register_policy_statement(statement)

Register a Policy Statement used by states in this graph.

Parameters:

statement (PolicyStatement) –

Return type:

None

register_state(state)

Register a state as part of this graph.

Called by State.bindToGraph().

Parameters:

state (State) –

Return type:

None

register_super_graph(graph)

Register this graph as a child of the given graph.

Resource changes will be bubbled up to the given graph.

Parameters:

graph (StateGraph) –

Return type:

None

to_graph_json()

Return the Amazon States Language JSON for this graph.

Return type:

Mapping[Any, Any]

to_string()

Return a string description of this graph.

Return type:

str

Attributes

policy_statements

The accumulated policy statements.

start_state

state that gets executed when the state machine is launched.

timeout

Set a timeout to render into the graph JSON.

Read/write. Only makes sense on the top-level graph, subgraphs do not support this feature.

Default:

No timeout