aws_ddk_core.resources.StepFunctionsFactory

class aws_ddk_core.resources.StepFunctionsFactory

Class factory create and configure AWS Step Functions Service DDK resources, including State Machines.

__init__()

Methods

__init__()

state_machine(scope, environment_id, id[, ...])

Create and configure state machine.
static state_machine(scope: constructs.Construct, environment_id: str, id: str, state_machine_name: Optional[str] = None, state_machine_type: Optional[aws_cdk.aws_stepfunctions.StateMachineType] = None, timeout: Optional[aws_ddk_core.resources.commons.Duration] = None, tracing_enabled: Optional[bool] = None, **state_machine_props: Any) → aws_cdk.aws_stepfunctions.StateMachine

Create and configure state machine.

This construct allows to configure parameters of the state machine using ddk.json configuration file depending on the environment_id in which the function is used. Supported parameters are: state_machine_type,`timeout`, and tracing_enabled.

Parameters

  • scope (Construct) – Scope within which this construct is defined

  • id (str) – Identifier of the state machine

  • environment_id (str) – Identifier of the environment

  • state_machine_name (Optional[str]) – Name of the state machine

  • state_machine_type (Optional[sfn.StateMachineType]) – Type of the state machine

  • timeout (Optional[Duration]) – Maximum run time for this state machine

  • tracing_enabled (Optional[bool]) – Specifies whether Amazon X-Ray tracing is enabled for this state machine

  • state_machine_props (Any) – Additional state machine properties. For complete list of properties refer to CDK Documentation - State Machine: https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_stepfunctions/StateMachine.html

Returns

state_machine – State machine

Return type

aws_cdk.aws_stepfunctions.StateMachine