Package software.amazon.awscdk.services.stepfunctions.tasks

Class StepFunctionsStartExecution.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.tasks.StepFunctionsStartExecution.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<StepFunctionsStartExecution>
Enclosing class:
StepFunctionsStartExecution
@Stability(Stable) public static final class StepFunctionsStartExecution.Builder extends Object implements software.amazon.jsii.Builder<StepFunctionsStartExecution>
A fluent builder for StepFunctionsStartExecution.

  • Method Details

    • create

      @Stability(Stable) public static StepFunctionsStartExecution.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - Descriptive identifier for this chainable. This parameter is required.
      Returns:
      a new instance of StepFunctionsStartExecution.Builder.

    • comment

      @Stability(Stable) public StepFunctionsStartExecution.Builder comment(String comment)
      A comment describing this state.

      Default: No comment

      Parameters:
      comment - A comment describing this state. This parameter is required.
      Returns:
      this

    • queryLanguage

      @Stability(Stable) public StepFunctionsStartExecution.Builder queryLanguage(QueryLanguage queryLanguage)
      The name of the query language used by the state.

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

      Default: - JSONPath

      Parameters:
      queryLanguage - The name of the query language used by the state. This parameter is required.
      Returns:
      this

    • stateName

      @Stability(Stable) public StepFunctionsStartExecution.Builder stateName(String stateName)
      Optional name for this state.

      Default: - The construct ID will be used as state name

      Parameters:
      stateName - Optional name for this state. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public StepFunctionsStartExecution.Builder credentials(Credentials credentials)
      Credentials for an IAM Role that the State Machine assumes for executing the task.

      This enables cross-account resource invocations.

      Default: - None (Task is executed using the State Machine's execution role)

      Parameters:
      credentials - Credentials for an IAM Role that the State Machine assumes for executing the task. This parameter is required.
      Returns:
      this
      See Also:

    • heartbeat

      @Stability(Deprecated) @Deprecated public StepFunctionsStartExecution.Builder heartbeat(Duration heartbeat)
      Deprecated.
      use heartbeatTimeout
      (deprecated) Timeout for the heartbeat.

      Default: - None

      Parameters:
      heartbeat - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • heartbeatTimeout

      @Stability(Stable) public StepFunctionsStartExecution.Builder heartbeatTimeout(Timeout heartbeatTimeout)
      Timeout for the heartbeat.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      heartbeatTimeout - Timeout for the heartbeat. This parameter is required.
      Returns:
      this

    • integrationPattern

      @Stability(Stable) public StepFunctionsStartExecution.Builder integrationPattern(IntegrationPattern integrationPattern)
      AWS Step Functions integrates with services directly in the Amazon States Language.

      You can control these AWS services using service integration patterns.

      Depending on the AWS Service, the Service Integration Pattern availability will vary.

      Default: - `IntegrationPattern.REQUEST_RESPONSE` for most tasks. `IntegrationPattern.RUN_JOB` for the following exceptions: `BatchSubmitJob`, `EmrAddStep`, `EmrCreateCluster`, `EmrTerminationCluster`, and `EmrContainersStartJobRun`.

      Parameters:
      integrationPattern - AWS Step Functions integrates with services directly in the Amazon States Language. This parameter is required.
      Returns:
      this
      See Also:

    • taskTimeout

      @Stability(Stable) public StepFunctionsStartExecution.Builder taskTimeout(Timeout taskTimeout)
      Timeout for the task.

      [disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

      Default: - None

      Parameters:
      taskTimeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Deprecated) @Deprecated public StepFunctionsStartExecution.Builder timeout(Duration timeout)
      Deprecated.
      use taskTimeout
      (deprecated) Timeout for the task.

      Default: - None

      Parameters:
      timeout - Timeout for the task. This parameter is required.
      Returns:
      this

    • assign

      @Stability(Stable) public StepFunctionsStartExecution.Builder assign(Map<String,? extends Object> assign)
      Workflow variables to store in this step.

      Using workflow variables, you can store data in a step and retrieve that data in future steps.

      Default: - Not assign variables

      Parameters:
      assign - Workflow variables to store in this step. This parameter is required.
      Returns:
      this
      See Also:

    • inputPath

      @Stability(Stable) public StepFunctionsStartExecution.Builder inputPath(String inputPath)
      JSONPath expression to select part of the state to be the input to this state.

      May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

      Default: $

      Parameters:
      inputPath - JSONPath expression to select part of the state to be the input to this state. This parameter is required.
      Returns:
      this

    • outputPath

      @Stability(Stable) public StepFunctionsStartExecution.Builder outputPath(String outputPath)
      JSONPath expression to select part of the state to be the output to this state.

      May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

      Default: $

      Parameters:
      outputPath - JSONPath expression to select part of the state to be the output to this state. This parameter is required.
      Returns:
      this

    • outputs

      @Stability(Stable) public StepFunctionsStartExecution.Builder outputs(Object outputs)
      Used to specify and transform output from the state.

      When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

      Default: - $states.result or $states.errorOutput

      Parameters:
      outputs - Used to specify and transform output from the state. This parameter is required.
      Returns:
      this
      See Also:

    • resultPath

      @Stability(Stable) public StepFunctionsStartExecution.Builder resultPath(String resultPath)
      JSONPath expression to indicate where to inject the state's output.

      May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

      Default: $

      Parameters:
      resultPath - JSONPath expression to indicate where to inject the state's output. This parameter is required.
      Returns:
      this

    • resultSelector

      @Stability(Stable) public StepFunctionsStartExecution.Builder resultSelector(Map<String,? extends Object> resultSelector)
      The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

      You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

      Default: - None

      Parameters:
      resultSelector - The JSON that will replace the state's raw result and become the effective result before ResultPath is applied. This parameter is required.
      Returns:
      this
      See Also:

    • stateMachine

      @Stability(Stable) public StepFunctionsStartExecution.Builder stateMachine(IStateMachine stateMachine)
      The Step Functions state machine to start the execution on.

      Parameters:
      stateMachine - The Step Functions state machine to start the execution on. This parameter is required.
      Returns:
      this

    • associateWithParent

      @Stability(Stable) public StepFunctionsStartExecution.Builder associateWithParent(Boolean associateWithParent)
      Pass the execution ID from the context object to the execution input.

      This allows the Step Functions UI to link child executions from parent executions, making it easier to trace execution flow across state machines.

      If you set this property to true, the input property must be an object (provided by sfn.TaskInput.fromObject) or omitted entirely.

      Default: - false

      Parameters:
      associateWithParent - Pass the execution ID from the context object to the execution input. This parameter is required.
      Returns:
      this
      See Also:

    • input

      @Stability(Stable) public StepFunctionsStartExecution.Builder input(TaskInput input)
      The JSON input for the execution, same as that of StartExecution.

      Default: - The state input (JSON path '$')

      Parameters:
      input - The JSON input for the execution, same as that of StartExecution. This parameter is required.
      Returns:
      this
      See Also:

    • name

      @Stability(Stable) public StepFunctionsStartExecution.Builder name(String name)
      The name of the execution, same as that of StartExecution.

      Default: - None

      Parameters:
      name - The name of the execution, same as that of StartExecution. This parameter is required.
      Returns:
      this
      See Also:

    • build

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