Wait¶
-
class
aws_cdk.aws_stepfunctions.
Wait
(scope, id, *, time, comment=None)¶ Bases:
aws_cdk.aws_stepfunctions.State
Define a Wait state in the state machine.
A Wait state can be used to delay execution of the state machine for a while.
- ExampleMetadata
infused
Example:
convert_to_seconds = tasks.EvaluateExpression(self, "Convert to seconds", expression="$.waitMilliseconds / 1000", result_path="$.waitSeconds" ) create_message = tasks.EvaluateExpression(self, "Create message", # Note: this is a string inside a string. expression="`Now waiting ${$.waitSeconds} seconds...`", runtime=lambda_.Runtime.NODEJS_14_X, result_path="$.message" ) publish_message = tasks.SnsPublish(self, "Publish message", topic=sns.Topic(self, "cool-topic"), message=sfn.TaskInput.from_json_path_at("$.message"), result_path="$.sns" ) wait = sfn.Wait(self, "Wait", time=sfn.WaitTime.seconds_path("$.waitSeconds") ) sfn.StateMachine(self, "StateMachine", definition=convert_to_seconds.next(create_message).next(publish_message).next(wait) )
- Parameters
Methods
-
add_prefix
(x)¶ Add a prefix to the stateId of this state.
- Parameters
x (
str
) –- Return type
None
-
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
) –- Return type
None
-
next
(next)¶ Continue normal execution with the given state.
- Parameters
next (
IChainable
) –- Return type
-
to_state_json
()¶ Return the Amazon States Language object for this state.
- Return type
Mapping
[Any
,Any
]
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
Attributes
-
id
¶ Descriptive identifier for this chainable.
- Return type
str
-
node
¶ The construct tree node associated with this construct.
- Return type
-
state_id
¶ Tokenized string that evaluates to the state’s ID.
- Return type
str
Static Methods
-
classmethod
filter_nextables
(states)¶ Return only the states that allow chaining from an array of states.
-
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.
-
classmethod
find_reachable_states
(start, *, include_error_handlers=None)¶ 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.
-
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
root (
IConstruct
) –prefix (
str
) –
- Return type
None