Package 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(Stable) public static final class StateMachine.Builder extends Object implements software.amazon.jsii.Builder<StateMachine>
A fluent builder for StateMachine.

  • 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.

    • comment

      @Stability(Stable) public StateMachine.Builder comment(String comment)
      Comment that describes this state machine.

      Default: - No comment

      Parameters:
      comment - Comment that describes this state machine. This parameter is required.
      Returns:
      this

    • definition

      @Stability(Deprecated) @Deprecated public StateMachine.Builder definition(IChainable definition)
      Deprecated.
      use definitionBody: DefinitionBody.fromChainable()
      (deprecated) Definition for this state machine.

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

    • definitionBody

      @Stability(Stable) public StateMachine.Builder definitionBody(DefinitionBody definitionBody)
      Definition for this state machine.

      Parameters:
      definitionBody - Definition for this state machine. This parameter is required.
      Returns:
      this

    • definitionSubstitutions

      @Stability(Stable) public StateMachine.Builder definitionSubstitutions(Map<String,String> definitionSubstitutions)
      substitutions for the definition body as a key-value map.

      Parameters:
      definitionSubstitutions - substitutions for the definition body as a key-value map. This parameter is required.
      Returns:
      this

    • encryptionConfiguration

      @Stability(Stable) public StateMachine.Builder encryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
      Configures server-side encryption of the state machine definition and execution history.

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

      Parameters:
      encryptionConfiguration - Configures server-side encryption of the state machine definition and execution history. This parameter is required.
      Returns:
      this

    • logs

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

    • removalPolicy

      @Stability(Stable) public StateMachine.Builder removalPolicy(RemovalPolicy removalPolicy)
      The removal policy to apply to state machine.

      Default: RemovalPolicy.DESTROY

      Parameters:
      removalPolicy - The removal policy to apply to state machine. This parameter is required.
      Returns:
      this

    • role

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

      @Stability(Stable) public StateMachine.Builder stateMachineName(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

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

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

      @Stability(Stable) public StateMachine.Builder tracingEnabled(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

      @Stability(Stable) public StateMachine build()
      Specified by:
      build in interface software.amazon.jsii.Builder<StateMachine>
      Returns:
      a newly built instance of StateMachine.