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

Class GlueStartJobRun.Builder

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

  • Method Details

    • create

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

    • comment

      @Stability(Stable) public GlueStartJobRun.Builder comment(String comment)
      An optional description for this state.

      Default: - No comment

      Parameters:
      comment - An optional description for this state. This parameter is required.
      Returns:
      this

    • credentials

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

    • inputPath

      @Stability(Stable) public GlueStartJobRun.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: - The entire task input (JSON path '$')

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

    • integrationPattern

      @Stability(Stable) public GlueStartJobRun.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:

    • outputPath

      @Stability(Stable) public GlueStartJobRun.Builder outputPath(String outputPath)
      JSONPath expression to select select a portion of the state output to pass to the next state.

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

      Default: - The entire JSON node determined by the state input, the task result, and resultPath is passed to the next state (JSON path '$')

      Parameters:
      outputPath - JSONPath expression to select select a portion of the state output to pass to the next state. This parameter is required.
      Returns:
      this

    • resultPath

      @Stability(Stable) public GlueStartJobRun.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: - Replaces the entire input with the result (JSON path '$')

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

    • resultSelector

      @Stability(Stable) public GlueStartJobRun.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:

    • stateName

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

    • taskTimeout

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

    • glueJobName

      @Stability(Stable) public GlueStartJobRun.Builder glueJobName(String glueJobName)
      Glue job name.

      Parameters:
      glueJobName - Glue job name. This parameter is required.
      Returns:
      this

    • arguments

      @Stability(Stable) public GlueStartJobRun.Builder arguments(TaskInput arguments)
      The job arguments specifically for this run.

      For this job run, they replace the default arguments set in the job definition itself.

      Default: - Default arguments set in the job definition

      Parameters:
      arguments - The job arguments specifically for this run. This parameter is required.
      Returns:
      this

    • executionClass

      @Stability(Stable) public GlueStartJobRun.Builder executionClass(ExecutionClass executionClass)
      The excecution class of the job.

      Default: - STANDARD

      Parameters:
      executionClass - The excecution class of the job. This parameter is required.
      Returns:
      this

    • notifyDelayAfter

      @Stability(Stable) public GlueStartJobRun.Builder notifyDelayAfter(Duration notifyDelayAfter)
      After a job run starts, the number of minutes to wait before sending a job run delay notification.

      Must be at least 1 minute.

      Default: - Default delay set in the job definition

      Parameters:
      notifyDelayAfter - After a job run starts, the number of minutes to wait before sending a job run delay notification. This parameter is required.
      Returns:
      this

    • securityConfiguration

      @Stability(Stable) public GlueStartJobRun.Builder securityConfiguration(String securityConfiguration)
      The name of the SecurityConfiguration structure to be used with this job run.

      This must match the Glue API

      Default: - Default configuration set in the job definition

      Parameters:
      securityConfiguration - The name of the SecurityConfiguration structure to be used with this job run. This parameter is required.
      Returns:
      this
      See Also:

    • workerConfiguration

      @Stability(Stable) public GlueStartJobRun.Builder workerConfiguration(WorkerConfigurationProperty workerConfiguration)
      The worker configuration for this run.

      Default: - Default worker configuration in the job definition

      Parameters:
      workerConfiguration - The worker configuration for this run. This parameter is required.
      Returns:
      this

    • build

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