Choice

class aws_cdk.aws_stepfunctions.Choice(scope, id, *, comment=None, input_path=None, output_path=None)

Bases: aws_cdk.aws_stepfunctions.State

Define a Choice in the state machine.

A choice state can be used to make decisions based on the execution state.

stability :stability: experimental

__init__(scope, id, *, comment=None, input_path=None, output_path=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • props

  • comment (Optional[str]) – An optional description for this state. Default: No comment

  • input_path (Optional[str]) – JSONPath expression to select part of the state to be the input to this state. May also be the special value DISCARD, which will cause the effective input to be the empty object {}. Default: $

  • output_path (Optional[str]) – JSONPath expression to select part of the state to be the output to this state. May also be the special value DISCARD, which will cause the effective output to be the empty object {}. Default: $

stability :stability: experimental

Return type

None

Methods

add_prefix(x)

Add a prefix to the stateId of this state.

Parameters

x (str) –

stability :stability: experimental

Return type

None

afterwards(*, include_error_handlers=None, include_otherwise=None)

Return a Chain that contains all reachable end states from this Choice.

Use this to combine all possible choice paths back.

Parameters
  • options

  • include_error_handlers (Optional[bool]) – Whether to include error handling states. If this is true, all states which are error handlers (added through ‘onError’) and states reachable via error handlers will be included as well. Default: false

  • include_otherwise (Optional[bool]) – Whether to include the default/otherwise transition for the current Choice state. If this is true and the current Choice does not have a default outgoing transition, one will be added included when .next() is called on the chain. Default: false

stability :stability: experimental

Return type

Chain

bind_to_graph(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.

Parameters

graph (StateGraph) –

stability :stability: experimental

Return type

None

otherwise(def_)

If none of the given conditions match, continue execution with the given state.

If no conditions match and no otherwise() has been given, an execution error will be raised.

Parameters

def

stability :stability: experimental

Return type

Choice

to_state_json()

Return the Amazon States Language object for this state.

stability :stability: experimental

Return type

Mapping[Any, Any]

to_string()

Returns a string representation of this construct.

Return type

str

when(condition, next)

If the given condition matches, continue execution with the given state.

Parameters

stability :stability: experimental

Return type

Choice

Attributes

end_states

Continuable states of this Chainable.

stability :stability: experimental

Return type

List[INextable]

id

Descriptive identifier for this chainable.

stability :stability: experimental

Return type

str

node

Construct tree node which offers APIs for interacting with the construct tree.

Return type

ConstructNode

start_state

First state of this Chainable.

stability :stability: experimental

Return type

State

state_id

Tokenized string that evaluates to the state’s ID.

stability :stability: experimental

Return type

str

Static Methods

classmethod filter_nextables(states)

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

Parameters

states (List[State]) –

stability :stability: experimental

Return type

List[INextable]

classmethod find_reachable_end_states(start, *, include_error_handlers=None)

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

Parameters
  • start (State) –

  • options

  • include_error_handlers (Optional[bool]) – Whether or not to follow error-handling transitions. Default: false

stability :stability: experimental

Return type

List[State]

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

classmethod prefix_states(root, prefix)

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

Parameters

stability :stability: experimental

Return type

None