software.amazon.awscdk.services.stepfunctions

Class StateGraph

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.stepfunctions.StateGraph

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:55.821Z")
public class StateGraph
extends software.amazon.jsii.JsiiObject

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.stepfunctions.*;
 State state;
 StateGraph stateGraph = new StateGraph(state, "graphDescription");
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StateGraph(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StateGraph(software.amazon.jsii.JsiiObjectRef objRef)
	StateGraph(State startState, java.lang.String graphDescription)

Method Summary

Modifier and Type	Method and Description
java.util.List<PolicyStatement>	getPolicyStatements() The accumulated policy statements.
State	getStartState() state that gets executed when the state machine is launched.
Duration	getTimeout() Set a timeout to render into the graph JSON.
void	registerPolicyStatement(PolicyStatement statement) Register a Policy Statement used by states in this graph.
void	registerState(State state) Register a state as part of this graph.
void	registerSuperGraph(StateGraph graph) Register this graph as a child of the given graph.
void	setTimeout(Duration value) Set a timeout to render into the graph JSON.
com.fasterxml.jackson.databind.node.ObjectNode	toGraphJson() Return the Amazon States Language JSON for this graph.
java.lang.String	toString() Return a string description of this graph.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StateGraph

protected StateGraph(software.amazon.jsii.JsiiObjectRef objRef)

StateGraph

protected StateGraph(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

StateGraph

public StateGraph(State startState,
                  java.lang.String graphDescription)

Parameters:

startState - state that gets executed when the state machine is launched. This parameter is required.

graphDescription - description of the state machine. This parameter is required.

Method Detail

registerPolicyStatement

public void registerPolicyStatement(PolicyStatement statement)

Register a Policy Statement used by states in this graph.

Parameters:

statement - This parameter is required.

registerState

public void registerState(State state)

Register a state as part of this graph.

Called by State.bindToGraph().

Parameters:

state - This parameter is required.

registerSuperGraph

public void registerSuperGraph(StateGraph graph)

Register this graph as a child of the given graph.

Resource changes will be bubbled up to the given graph.

Parameters:

graph - This parameter is required.

toGraphJson

public com.fasterxml.jackson.databind.node.ObjectNode toGraphJson()

Return the Amazon States Language JSON for this graph.

toString

public java.lang.String toString()

Return a string description of this graph.

getPolicyStatements

public java.util.List<PolicyStatement> getPolicyStatements()

The accumulated policy statements.

getStartState

public State getStartState()

state that gets executed when the state machine is launched.

getTimeout

public Duration getTimeout()

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

setTimeout

public void setTimeout(Duration value)

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