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.116.0 (build 0eddcff)", date="2025-10-24T13:34:47.888Z") @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());

  • Method Details

    • getComment

      @Stability(Stable) @Nullable default String getComment()
      Comment that describes this state machine.

      Default: - No comment

    • getDefinition

      @Stability(Deprecated) @Deprecated @Nullable default IChainable getDefinition()
      Deprecated.
      use definitionBody: DefinitionBody.fromChainable()
      (deprecated) Definition for this state machine.

    • getDefinitionBody

      @Stability(Stable) @Nullable default DefinitionBody getDefinitionBody()
      Definition for this state machine.

    • getDefinitionSubstitutions

      @Stability(Stable) @Nullable default Map<String,String> getDefinitionSubstitutions()
      substitutions for the definition body as a key-value map.

    • getEncryptionConfiguration

      @Stability(Stable) @Nullable default EncryptionConfiguration getEncryptionConfiguration()
      Configures server-side encryption of the state machine definition and execution history.

      Default: - data is transparently encrypted using an AWS owned key

    • getLogs

      @Stability(Stable) @Nullable default LogOptions getLogs()
      Defines what execution history events are logged and where they are logged.

      Default: No logging

    • getQueryLanguage

      @Stability(Stable) @Nullable default QueryLanguage getQueryLanguage()
      The name of the query language used by the state machine.

      If the state does not contain a queryLanguage field, then it will use the query language specified in this queryLanguage field.

      Default: - JSON_PATH

    • getRemovalPolicy

      @Stability(Stable) @Nullable default RemovalPolicy getRemovalPolicy()
      The removal policy to apply to state machine.

      Default: RemovalPolicy.DESTROY

    • getRole

      @Stability(Stable) @Nullable default IRoleRef 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