Class StateMachine.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.StateMachine.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<StateMachine>
- Enclosing class:
StateMachine
@Stability(Stable)
public static final class StateMachine.Builder
extends Object
implements software.amazon.jsii.Builder<StateMachine>
A fluent builder for
StateMachine
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static StateMachine.Builder
definition
(IChainable definition) Definition for this state machine.logs
(LogOptions logs) Defines what execution history events are logged and where they are logged.The execution role for the state machine service.stateMachineName
(String stateMachineName) A name for the state machine.stateMachineType
(StateMachineType stateMachineType) Type of the state machine.Maximum run time for this state machine.tracingEnabled
(Boolean tracingEnabled) Specifies whether Amazon X-Ray tracing is enabled for this state machine.
-
Method Details
-
create
@Stability(Stable) public static StateMachine.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- This parameter is required.- Returns:
- a new instance of
StateMachine.Builder
.
-
definition
Definition for this state machine.- Parameters:
definition
- Definition for this state machine. This parameter is required.- Returns:
this
-
logs
Defines what execution history events are logged and where they are logged.Default: No logging
- Parameters:
logs
- Defines what execution history events are logged and where they are logged. This parameter is required.- Returns:
this
-
role
The execution role for the state machine service.Default: A role is automatically created
- Parameters:
role
- The execution role for the state machine service. This parameter is required.- Returns:
this
-
stateMachineName
A name for the state machine.Default: A name is automatically generated
- Parameters:
stateMachineName
- A name for the state machine. This parameter is required.- Returns:
this
-
stateMachineType
Type of the state machine.Default: StateMachineType.STANDARD
- Parameters:
stateMachineType
- Type of the state machine. This parameter is required.- Returns:
this
-
timeout
Maximum run time for this state machine.Default: No timeout
- Parameters:
timeout
- Maximum run time for this state machine. This parameter is required.- Returns:
this
-
tracingEnabled
Specifies whether Amazon X-Ray tracing is enabled for this state machine.Default: false
- Parameters:
tracingEnabled
- Specifies whether Amazon X-Ray tracing is enabled for this state machine. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<StateMachine>
- Returns:
- a newly built instance of
StateMachine
.
-