software.amazon.awscdk.services.stepfunctions

Class StateMachine.Builder

java.lang.Object

software.amazon.awscdk.services.stepfunctions.StateMachine.Builder

Enclosing class:

StateMachine

public static final class StateMachine.Builder
extends java.lang.Object

A fluent builder for StateMachine.

Method Summary

Modifier and Type	Method and Description
StateMachine	build()
static StateMachine.Builder	create(software.constructs.Construct scope, java.lang.String id)
StateMachine.Builder	definition(IChainable definition) Definition for this state machine.
StateMachine.Builder	logs(LogOptions logs) Defines what execution history events are logged and where they are logged.
StateMachine.Builder	role(IRole role) The execution role for the state machine service.
StateMachine.Builder	stateMachineName(java.lang.String stateMachineName) A name for the state machine.
StateMachine.Builder	stateMachineType(StateMachineType stateMachineType) Type of the state machine.
StateMachine.Builder	timeout(Duration timeout) Maximum run time for this state machine.
StateMachine.Builder	tracingEnabled(java.lang.Boolean tracingEnabled) Specifies whether Amazon X-Ray tracing is enabled for this state machine.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StateMachine.Builder create(software.constructs.Construct scope,
                                          java.lang.String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of StateMachine.Builder.

definition

public StateMachine.Builder definition(IChainable definition)

Definition for this state machine.

Parameters:

definition - Definition for this state machine. This parameter is required.

Returns:

this

logs

public StateMachine.Builder logs(LogOptions 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

public StateMachine.Builder role(IRole 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

public StateMachine.Builder stateMachineName(java.lang.String 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

public StateMachine.Builder stateMachineType(StateMachineType stateMachineType)

Type of the state machine.

Default: StateMachineType.STANDARD

Parameters:

stateMachineType - Type of the state machine. This parameter is required.

Returns:

this

timeout

public StateMachine.Builder timeout(Duration 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

public StateMachine.Builder tracingEnabled(java.lang.Boolean 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

public StateMachine build()