Package software.amazon.awscdk.services.stepfunctions

Interface StateMachineProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StateMachineProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:39.937Z")
@Stability(Stable)
public interface StateMachineProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a State Machine.

Example:

 import software.amazon.awscdk.services.stepfunctions.*;
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 Artifact inputArtifact = new Artifact();
 Pass startState = new Pass(this, "StartState");
 StateMachine simpleStateMachine = StateMachine.Builder.create(this, "SimpleStateMachine")
         .definition(startState)
         .build();
 StepFunctionInvokeAction stepFunctionAction = StepFunctionInvokeAction.Builder.create()
         .actionName("Invoke")
         .stateMachine(simpleStateMachine)
         .stateMachineInput(StateMachineInput.filePath(inputArtifact.atPath("assets/input.json")))
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("StepFunctions")
         .actions(List.of(stepFunctionAction))
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StateMachineProps.Builder	A builder for StateMachineProps
static final class	StateMachineProps.Jsii$Proxy	An implementation for StateMachineProps

Method Summary

Modifier and Type	Method	Description
static StateMachineProps.Builder	builder()
IChainable	getDefinition()	Definition for this state machine.
default LogOptions	getLogs()	Defines what execution history events are logged and where they are logged.
default IRole	getRole()	The execution role for the state machine service.
default String	getStateMachineName()	A name for the state machine.
default StateMachineType	getStateMachineType()	Type of the state machine.
default Duration	getTimeout()	Maximum run time for this state machine.
default Boolean	getTracingEnabled()	Specifies whether Amazon X-Ray tracing is enabled for this state machine.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefinition

@Stability(Stable)
@NotNull
IChainable getDefinition()

Definition for this state machine.

getLogs

@Stability(Stable)
@Nullable
default LogOptions getLogs()

Defines what execution history events are logged and where they are logged.

Default: No logging

getRole

@Stability(Stable)
@Nullable
default IRole getRole()

The execution role for the state machine service.

Default: A role is automatically created

getStateMachineName

@Stability(Stable)
@Nullable
default String getStateMachineName()

A name for the state machine.

Default: A name is automatically generated

getStateMachineType

@Stability(Stable)
@Nullable
default StateMachineType getStateMachineType()

Type of the state machine.

Default: StateMachineType.STANDARD

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

Maximum run time for this state machine.

Default: No timeout

getTracingEnabled

@Stability(Stable)
@Nullable
default Boolean getTracingEnabled()

Specifies whether Amazon X-Ray tracing is enabled for this state machine.

Default: false

builder

@Stability(Stable)
static StateMachineProps.Builder builder()

Returns:

a StateMachineProps.Builder of StateMachineProps