Package software.amazon.awscdk.cfnpropertymixins.services.glue

Class CfnJobMixinProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • allocatedCapacity

      @Stability(Stable) public CfnJobMixinProps.Builder allocatedCapacity(Number allocatedCapacity)
      Sets the value of CfnJobMixinProps.getAllocatedCapacity()
      Parameters:
      allocatedCapacity - This parameter is no longer supported. Use MaxCapacity instead. The number of capacity units that are allocated to this job.
      Returns:
      this

    • command

      @Stability(Stable) public CfnJobMixinProps.Builder command(IResolvable command)
      Sets the value of CfnJobMixinProps.getCommand()
      Parameters:
      command - The code that executes a job.
      Returns:
      this

    • command

      @Stability(Stable) public CfnJobMixinProps.Builder command(CfnJobPropsMixin.JobCommandProperty command)
      Sets the value of CfnJobMixinProps.getCommand()
      Parameters:
      command - The code that executes a job.
      Returns:
      this

    • connections

      @Stability(Stable) public CfnJobMixinProps.Builder connections(IResolvable connections)
      Sets the value of CfnJobMixinProps.getConnections()
      Parameters:
      connections - The connections used for this job.
      Returns:
      this

    • connections

      @Stability(Stable) public CfnJobMixinProps.Builder connections(CfnJobPropsMixin.ConnectionsListProperty connections)
      Sets the value of CfnJobMixinProps.getConnections()
      Parameters:
      connections - The connections used for this job.
      Returns:
      this

    • defaultArguments

      @Stability(Stable) public CfnJobMixinProps.Builder defaultArguments(Object defaultArguments)
      Sets the value of CfnJobMixinProps.getDefaultArguments()
      Parameters:
      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 .

      Returns:
      this

    • description

      @Stability(Stable) public CfnJobMixinProps.Builder description(String description)
      Sets the value of CfnJobMixinProps.getDescription()
      Parameters:
      description - A description of the job.
      Returns:
      this

    • executionClass

      @Stability(Stable) public CfnJobMixinProps.Builder executionClass(String executionClass)
      Sets the value of CfnJobMixinProps.getExecutionClass()
      Parameters:
      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.

      Returns:
      this

    • executionProperty

      @Stability(Stable) public CfnJobMixinProps.Builder executionProperty(IResolvable executionProperty)
      Sets the value of CfnJobMixinProps.getExecutionProperty()
      Parameters:
      executionProperty - The maximum number of concurrent runs that are allowed for this job.
      Returns:
      this

    • executionProperty

      @Stability(Stable) public CfnJobMixinProps.Builder executionProperty(CfnJobPropsMixin.ExecutionPropertyProperty executionProperty)
      Sets the value of CfnJobMixinProps.getExecutionProperty()
      Parameters:
      executionProperty - The maximum number of concurrent runs that are allowed for this job.
      Returns:
      this

    • glueVersion

      @Stability(Stable) public CfnJobMixinProps.Builder glueVersion(String glueVersion)
      Sets the value of CfnJobMixinProps.getGlueVersion()
      Parameters:
      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 the latest Glue version available.

      Returns:
      this

    • jobMode

      @Stability(Stable) public CfnJobMixinProps.Builder jobMode(String jobMode)
      Sets the value of CfnJobMixinProps.getJobMode()
      Parameters:
      jobMode - A mode that describes how a job was created. Valid values are:.
      • SCRIPT - The job was created using the AWS Glue Studio script editor.
      • VISUAL - The job was created using the AWS Glue Studio visual editor.
      • NOTEBOOK - The job was created using an interactive sessions notebook.

      When the JobMode field is missing or null, SCRIPT is assigned as the default value.

      Returns:
      this

    • jobRunQueuingEnabled

      @Stability(Stable) public CfnJobMixinProps.Builder jobRunQueuingEnabled(Boolean jobRunQueuingEnabled)
      Sets the value of CfnJobMixinProps.getJobRunQueuingEnabled()
      Parameters:
      jobRunQueuingEnabled - Specifies whether job run queuing is enabled for the job runs for this job. A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.

      If this field does not match the value set in the job run, then the value from the job run field will be used.

      Returns:
      this

    • jobRunQueuingEnabled

      @Stability(Stable) public CfnJobMixinProps.Builder jobRunQueuingEnabled(IResolvable jobRunQueuingEnabled)
      Sets the value of CfnJobMixinProps.getJobRunQueuingEnabled()
      Parameters:
      jobRunQueuingEnabled - Specifies whether job run queuing is enabled for the job runs for this job. A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.

      If this field does not match the value set in the job run, then the value from the job run field will be used.

      Returns:
      this

    • logUri

      @Stability(Stable) public CfnJobMixinProps.Builder logUri(String logUri)
      Sets the value of CfnJobMixinProps.getLogUri()
      Parameters:
      logUri - This field is reserved for future use.
      Returns:
      this

    • maintenanceWindow

      @Stability(Stable) public CfnJobMixinProps.Builder maintenanceWindow(String maintenanceWindow)
      Sets the value of CfnJobMixinProps.getMaintenanceWindow()
      Parameters:
      maintenanceWindow - This field specifies a day of the week and hour for a maintenance window for streaming jobs. AWS Glue periodically performs maintenance activities. During these maintenance windows, AWS Glue will need to restart your streaming jobs.

      AWS Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.

      Returns:
      this

    • maxCapacity

      @Stability(Stable) public CfnJobMixinProps.Builder maxCapacity(Number maxCapacity)
      Sets the value of CfnJobMixinProps.getMaxCapacity()
      Parameters:
      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.
      Returns:
      this

    • maxRetries

      @Stability(Stable) public CfnJobMixinProps.Builder maxRetries(Number maxRetries)
      Sets the value of CfnJobMixinProps.getMaxRetries()
      Parameters:
      maxRetries - The maximum number of times to retry this job after a JobRun fails.
      Returns:
      this

    • name

      @Stability(Stable) public CfnJobMixinProps.Builder name(String name)
      Sets the value of CfnJobMixinProps.getName()
      Parameters:
      name - The name you assign to this job definition.
      Returns:
      this

    • nonOverridableArguments

      @Stability(Stable) public CfnJobMixinProps.Builder nonOverridableArguments(Object nonOverridableArguments)
      Sets the value of CfnJobMixinProps.getNonOverridableArguments()
      Parameters:
      nonOverridableArguments - Non-overridable arguments for this job, specified as name-value pairs.
      Returns:
      this

    • notificationProperty

      @Stability(Stable) public CfnJobMixinProps.Builder notificationProperty(IResolvable notificationProperty)
      Sets the value of CfnJobMixinProps.getNotificationProperty()
      Parameters:
      notificationProperty - Specifies configuration properties of a notification.
      Returns:
      this

    • notificationProperty

      @Stability(Stable) public CfnJobMixinProps.Builder notificationProperty(CfnJobPropsMixin.NotificationPropertyProperty notificationProperty)
      Sets the value of CfnJobMixinProps.getNotificationProperty()
      Parameters:
      notificationProperty - Specifies configuration properties of a notification.
      Returns:
      this

    • numberOfWorkers

      @Stability(Stable) public CfnJobMixinProps.Builder numberOfWorkers(Number numberOfWorkers)
      Sets the value of CfnJobMixinProps.getNumberOfWorkers()
      Parameters:
      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 .
      Returns:
      this

    • role

      @Stability(Stable) public CfnJobMixinProps.Builder role(String role)
      Sets the value of CfnJobMixinProps.getRole()
      Parameters:
      role - The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
      Returns:
      this

    • role

      @Stability(Stable) public CfnJobMixinProps.Builder role(IRoleRef role)
      Sets the value of CfnJobMixinProps.getRole()
      Parameters:
      role - The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
      Returns:
      this

    • securityConfiguration

      @Stability(Stable) public CfnJobMixinProps.Builder securityConfiguration(String securityConfiguration)
      Sets the value of CfnJobMixinProps.getSecurityConfiguration()
      Parameters:
      securityConfiguration - The name of the SecurityConfiguration structure to be used with this job.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnJobMixinProps.Builder tags(Object tags)
      Sets the value of CfnJobMixinProps.getTags()
      Parameters:
      tags - The tags to use with this job.
      Returns:
      this

    • timeout

      @Stability(Stable) public CfnJobMixinProps.Builder timeout(Number timeout)
      Sets the value of CfnJobMixinProps.getTimeout()
      Parameters:
      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).
      Returns:
      this

    • workerType

      @Stability(Stable) public CfnJobMixinProps.Builder workerType(String workerType)
      Sets the value of CfnJobMixinProps.getWorkerType()
      Parameters:
      workerType - The type of predefined worker that is allocated when a job runs. AWS Glue provides multiple worker types to accommodate different workload requirements:

      G Worker Types (General-purpose compute workers):

      • G.1X: 1 DPU (4 vCPUs, 16 GB memory, 94GB disk)
      • G.2X: 2 DPU (8 vCPUs, 32 GB memory, 138GB disk)
      • G.4X: 4 DPU (16 vCPUs, 64 GB memory, 256GB disk)
      • G.8X: 8 DPU (32 vCPUs, 128 GB memory, 512GB disk)
      • G.12X: 12 DPU (48 vCPUs, 192 GB memory, 768GB disk)
      • G.16X: 16 DPU (64 vCPUs, 256 GB memory, 1024GB disk)

      R Worker Types (Memory-optimized workers):

      • R.1X: 1 M-DPU (4 vCPUs, 32 GB memory)
      • R.2X: 2 M-DPU (8 vCPUs, 64 GB memory)
      • R.4X: 4 M-DPU (16 vCPUs, 128 GB memory)
      • R.8X: 8 M-DPU (32 vCPUs, 256 GB memory)
      Returns:
      this

    • build

      @Stability(Stable) public CfnJobMixinProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnJobMixinProps>
      Returns:
      a new instance of CfnJobMixinProps
      Throws:
      NullPointerException - if any required attribute was not provided