Interface StartWorkflowRunRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>, MwaaServerlessRequest.Builder, SdkBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartWorkflowRunRequest
@Mutable @NotThreadSafe public static interface StartWorkflowRunRequest.Builder extends MwaaServerlessRequest.Builder, SdkPojo, CopyableBuilder<StartWorkflowRunRequest.Builder,StartWorkflowRunRequest>

  • Method Details

    • workflowArn

      StartWorkflowRunRequest.Builder workflowArn(String workflowArn)

      The Amazon Resource Name (ARN) of the workflow you want to run.

      Parameters:
      workflowArn - The Amazon Resource Name (ARN) of the workflow you want to run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartWorkflowRunRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token prevents duplicate workflow run requests.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideParameters

      StartWorkflowRunRequest.Builder overrideParameters(Map<String,Document> overrideParameters)

      Optional parameters to override default workflow parameters for this specific run. These parameters are passed to the workflow during execution and can be used to customize behavior without modifying the workflow definition. Parameters are made available as environment variables to tasks and you can reference them within the YAML workflow definition using standard parameter substitution syntax.

      Parameters:
      overrideParameters - Optional parameters to override default workflow parameters for this specific run. These parameters are passed to the workflow during execution and can be used to customize behavior without modifying the workflow definition. Parameters are made available as environment variables to tasks and you can reference them within the YAML workflow definition using standard parameter substitution syntax.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workflowVersion

      StartWorkflowRunRequest.Builder workflowVersion(String workflowVersion)

      Optional. The specific version of the workflow to execute. If not specified, the latest version is used.

      Parameters:
      workflowVersion - Optional. The specific version of the workflow to execute. If not specified, the latest version is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartWorkflowRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartWorkflowRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.