software.amazon.awscdk.services.stepfunctions

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(value=Experimental)
public static final class StateMachine.Builder
extends Object
implements software.amazon.jsii.Builder<StateMachine>

(experimental) A fluent builder for StateMachine.

Method Summary

Modifier and Type	Method and Description
StateMachine	build()
static StateMachine.Builder	create(software.constructs.Construct scope, String id)
StateMachine.Builder	definition(IChainable definition) (experimental) Definition for this state machine.
StateMachine.Builder	logs(LogOptions logs) (experimental) Defines what execution history events are logged and where they are logged.
StateMachine.Builder	role(IRole role) (experimental) The execution role for the state machine service.
StateMachine.Builder	stateMachineName(String stateMachineName) (experimental) A name for the state machine.
StateMachine.Builder	stateMachineType(StateMachineType stateMachineType) (experimental) Type of the state machine.
StateMachine.Builder	timeout(Duration timeout) (experimental) Maximum run time for this state machine.
StateMachine.Builder	tracingEnabled(Boolean tracingEnabled) (experimental) 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

@Stability(value=Experimental)
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

@Stability(value=Experimental)
public StateMachine.Builder definition(IChainable definition)

(experimental) Definition for this state machine.

Parameters:

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

Returns:

this

logs

@Stability(value=Experimental)
public StateMachine.Builder logs(LogOptions logs)

(experimental) 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

@Stability(value=Experimental)
public StateMachine.Builder role(IRole role)

(experimental) 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

@Stability(value=Experimental)
public StateMachine.Builder stateMachineName(String stateMachineName)

(experimental) 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

@Stability(value=Experimental)
public StateMachine.Builder stateMachineType(StateMachineType stateMachineType)

(experimental) Type of the state machine.

Default: StateMachineType.STANDARD

Parameters:

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

Returns:

this

timeout

@Stability(value=Experimental)
public StateMachine.Builder timeout(Duration timeout)

(experimental) 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

@Stability(value=Experimental)
public StateMachine.Builder tracingEnabled(Boolean tracingEnabled)

(experimental) 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

@Stability(value=Experimental)
public StateMachine build()

Specified by:

build in interface software.amazon.jsii.Builder<StateMachine>