AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Glue::Job

CfnJob

The `AWS::Glue::Job` resource specifies an AWS Glue job in the data catalog. For more information, see [Adding Jobs in AWS Glue](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) and [Job Structure](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html#aws-glue-api-jobs-job-Job) in the *AWS Glue Developer Guide.*

Import

import { CfnJob } from 'aws-cdk-lib/aws-glue';

Or use the module namespace:

import * as glue from 'aws-cdk-lib/aws-glue';
// glue.CfnJob

Properties

Configuration passed to the constructor as CfnJobProps.

commandRequired
IResolvable | JobCommandProperty

The code that executes a job.

roleRequired
string | IRoleRef

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

allocatedCapacityOptional
number

This parameter is no longer supported. Use `MaxCapacity` instead. The number of capacity units that are allocated to this job.

connectionsOptional
IResolvable | ConnectionsListProperty

The connections used for this job.

defaultArgumentsOptional
any

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](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 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](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) in the *AWS Glue Developer Guide* .

descriptionOptional
string

A description of the job.

executionClassOptional
string

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.

executionPropertyOptional
IResolvable | ExecutionPropertyProperty

The maximum number of concurrent runs that are allowed for this job.

glueVersionOptional
string

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](https://docs.aws.amazon.com/glue/latest/dg/add-job.html) in the developer guide. Jobs that are created without specifying a Glue version default to the latest Glue version available.

jobModeOptional
string

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.

jobRunQueuingEnabledOptional
boolean | IResolvable

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.

logUriOptional
string

This field is reserved for future use.

maintenanceWindowOptional
string

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.

maxCapacityOptional
number

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.

maxRetriesOptional
number

The maximum number of times to retry this job after a JobRun fails.

nameOptional
string

The name you assign to this job definition.

nonOverridableArgumentsOptional
any

Non-overridable arguments for this job, specified as name-value pairs.

notificationPropertyOptional
IResolvable | NotificationPropertyProperty

Specifies configuration properties of a notification.

numberOfWorkersOptional
number

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` .

securityConfigurationOptional
string

The name of the `SecurityConfiguration` structure to be used with this job.

tagsOptional
any

The tags to use with this job.

timeoutOptional
number

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).

workerTypeOptional
string

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)

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter