Package software.amazon.awscdk.services.glue

Class CfnJob.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnJob.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnJob.Builder.

    • command

      @Stability(Stable) public CfnJob.Builder command(IResolvable command)
      The code that executes a job.

      Parameters:
      command - The code that executes a job. This parameter is required.
      Returns:
      this

    • command

      @Stability(Stable) public CfnJob.Builder command(CfnJob.JobCommandProperty command)
      The code that executes a job.

      Parameters:
      command - The code that executes a job. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public CfnJob.Builder role(String role)
      The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

      Parameters:
      role - The name or Amazon Resource Name (ARN) of the IAM role associated with this job. This parameter is required.
      Returns:
      this

    • allocatedCapacity

      @Stability(Stable) public CfnJob.Builder allocatedCapacity(Number allocatedCapacity)
      This parameter is no longer supported. Use MaxCapacity instead.

      The number of capacity units that are allocated to this job.

      Parameters:
      allocatedCapacity - This parameter is no longer supported. Use MaxCapacity instead. This parameter is required.
      Returns:
      this

    • connections

      @Stability(Stable) public CfnJob.Builder connections(IResolvable connections)
      The connections used for this job.

      Parameters:
      connections - The connections used for this job. This parameter is required.
      Returns:
      this

    • connections

      @Stability(Stable) public CfnJob.Builder connections(CfnJob.ConnectionsListProperty connections)
      The connections used for this job.

      Parameters:
      connections - The connections used for this job. This parameter is required.
      Returns:
      this

    • defaultArguments

      @Stability(Stable) public CfnJob.Builder defaultArguments(Object defaultArguments)
      The default arguments for this job, specified as name-value pairs.

      You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes.

      For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python in the AWS Glue Developer Guide .

      For information about the key-value pairs that AWS Glue consumes to set up your job, see Special Parameters Used by AWS Glue in the AWS Glue Developer Guide .

      Parameters:
      defaultArguments - The default arguments for this job, specified as name-value pairs. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnJob.Builder description(String description)
      A description of the job.

      Parameters:
      description - A description of the job. This parameter is required.
      Returns:
      this

    • executionClass

      @Stability(Stable) public CfnJob.Builder executionClass(String executionClass)
      Indicates whether the job is run with a standard or flexible execution class.

      The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

      The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

      Only jobs with AWS Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX . The flexible execution class is available for Spark jobs.

      Parameters:
      executionClass - Indicates whether the job is run with a standard or flexible execution class. This parameter is required.
      Returns:
      this

    • executionProperty

      @Stability(Stable) public CfnJob.Builder executionProperty(IResolvable executionProperty)
      The maximum number of concurrent runs that are allowed for this job.

      Parameters:
      executionProperty - The maximum number of concurrent runs that are allowed for this job. This parameter is required.
      Returns:
      this

    • executionProperty

      @Stability(Stable) public CfnJob.Builder executionProperty(CfnJob.ExecutionPropertyProperty executionProperty)
      The maximum number of concurrent runs that are allowed for this job.

      Parameters:
      executionProperty - The maximum number of concurrent runs that are allowed for this job. This parameter is required.
      Returns:
      this

    • glueVersion

      @Stability(Stable) public CfnJob.Builder glueVersion(String glueVersion)
      Glue version determines the versions of Apache Spark and Python that AWS Glue supports.

      The Python version indicates the version supported for jobs of type Spark.

      For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

      Jobs that are created without specifying a Glue version default to Glue 0.9.

      Parameters:
      glueVersion - Glue version determines the versions of Apache Spark and Python that AWS Glue supports. This parameter is required.
      Returns:
      this

    • logUri

      @Stability(Stable) public CfnJob.Builder logUri(String logUri)
      This field is reserved for future use.

      Parameters:
      logUri - This field is reserved for future use. This parameter is required.
      Returns:
      this

    • maxCapacity

      @Stability(Stable) public CfnJob.Builder maxCapacity(Number maxCapacity)
      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.

      A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

      Do not set Max Capacity if using WorkerType and NumberOfWorkers .

      The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

      • When you specify a Python shell job ( JobCommand.Name ="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
      • When you specify an Apache Spark ETL job ( JobCommand.Name ="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

      Parameters:
      maxCapacity - The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. This parameter is required.
      Returns:
      this

    • maxRetries

      @Stability(Stable) public CfnJob.Builder maxRetries(Number maxRetries)
      The maximum number of times to retry this job after a JobRun fails.

      Parameters:
      maxRetries - The maximum number of times to retry this job after a JobRun fails. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnJob.Builder name(String name)
      The name you assign to this job definition.

      Parameters:
      name - The name you assign to this job definition. This parameter is required.
      Returns:
      this

    • nonOverridableArguments

      @Stability(Stable) public CfnJob.Builder nonOverridableArguments(Object nonOverridableArguments)
      Non-overridable arguments for this job, specified as name-value pairs.

      Parameters:
      nonOverridableArguments - Non-overridable arguments for this job, specified as name-value pairs. This parameter is required.
      Returns:
      this

    • notificationProperty

      @Stability(Stable) public CfnJob.Builder notificationProperty(IResolvable notificationProperty)
      Specifies configuration properties of a notification.

      Parameters:
      notificationProperty - Specifies configuration properties of a notification. This parameter is required.
      Returns:
      this

    • notificationProperty

      @Stability(Stable) public CfnJob.Builder notificationProperty(CfnJob.NotificationPropertyProperty notificationProperty)
      Specifies configuration properties of a notification.

      Parameters:
      notificationProperty - Specifies configuration properties of a notification. This parameter is required.
      Returns:
      this

    • numberOfWorkers

      @Stability(Stable) public CfnJob.Builder numberOfWorkers(Number numberOfWorkers)
      The number of workers of a defined workerType that are allocated when a job runs.

      The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

      Parameters:
      numberOfWorkers - The number of workers of a defined workerType that are allocated when a job runs. This parameter is required.
      Returns:
      this

    • securityConfiguration

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

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

    • tags

      @Stability(Stable) public CfnJob.Builder tags(Object tags)
      The tags to use with this job.

      Parameters:
      tags - The tags to use with this job. This parameter is required.
      Returns:
      this

    • timeout

      @Stability(Stable) public CfnJob.Builder timeout(Number timeout)
      The job timeout in minutes.

      This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

      Parameters:
      timeout - The job timeout in minutes. This parameter is required.
      Returns:
      this

    • workerType

      @Stability(Stable) public CfnJob.Builder workerType(String workerType)
      The type of predefined worker that is allocated when a job runs.

      Accepts a value of Standard, G.1X, or G.2X.

      • For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
      • For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
      • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

      Parameters:
      workerType - The type of predefined worker that is allocated when a job runs. This parameter is required.
      Returns:
      this

    • build

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