aws-cdk-lib.aws_glue.CfnJobProps

CfnJobProps Struct

Properties for defining a CfnJob.

CfnJobProps

used as props by

• CfnJob

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';

declare const defaultArguments: any;
declare const nonOverridableArguments: any;
declare const tags: any;
const cfnJobProps: glue.CfnJobProps = {
  command: {
    name: 'name',
    pythonVersion: 'pythonVersion',
    runtime: 'runtime',
    scriptLocation: 'scriptLocation',
  },
  role: 'role',

  // the properties below are optional
  allocatedCapacity: 123,
  connections: {
    connections: ['connections'],
  },
  defaultArguments: defaultArguments,
  description: 'description',
  executionClass: 'executionClass',
  executionProperty: {
    maxConcurrentRuns: 123,
  },
  glueVersion: 'glueVersion',
  jobMode: 'jobMode',
  jobRunQueuingEnabled: false,
  logUri: 'logUri',
  maintenanceWindow: 'maintenanceWindow',
  maxCapacity: 123,
  maxRetries: 123,
  name: 'name',
  nonOverridableArguments: nonOverridableArguments,
  notificationProperty: {
    notifyDelayAfter: 123,
  },
  numberOfWorkers: 123,
  securityConfiguration: 'securityConfiguration',
  tags: tags,
  timeout: 123,
  workerType: 'workerType',
};

Properties

allocatedCapacity?optionalnumberallocated_capacity?optionalint | floatallocatedCapacity?optionalNumberAllocatedCapacity?optionaldoubleAllocatedCapacity?optional*float64#

This parameter is no longer supported. Use `MaxCapacity` instead.

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

commandIResolvable | CfnJob.JobCommandPropertycommandtyping.Union[IResolvable, JobCommandProperty]commandIResolvableCommandIResolvableCommandinterface{}required#

The code that executes a job.

connections?optionalIResolvable | CfnJob.ConnectionsListPropertyconnections?optionaltyping.Union[IResolvable, ConnectionsListProperty]connections?optionalIResolvableConnections?optionalIResolvableConnections?optionalinterface{}#

The connections used for this job.

defaultArguments?optionalanydefault_arguments?optionalAnydefaultArguments?optionalObjectDefaultArguments?optionalobjectDefaultArguments?optionalinterface{}#

The default arguments for this job, specified as name-value pairs.

notes

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 .

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A description of the job.

executionClass?optionalstringexecution_class?optionalstrexecutionClass?optionalStringExecutionClass?optionalstringExecutionClass?optional*string#

Indicates whether the job is run with a standard or flexible execution class.

notes

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.

executionProperty?optionalIResolvable | CfnJob.ExecutionPropertyPropertyexecution_property?optionaltyping.Union[IResolvable, ExecutionPropertyProperty]executionProperty?optionalIResolvableExecutionProperty?optionalIResolvableExecutionProperty?optionalinterface{}#

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

glueVersion?optionalstringglue_version?optionalstrglueVersion?optionalStringGlueVersion?optionalstringGlueVersion?optional*string#

Glue version determines the versions of Apache Spark and Python that AWS Glue supports.

notes

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.

jobMode?optionalstringjob_mode?optionalstrjobMode?optionalStringJobMode?optionalstringJobMode?optional*string#

A mode that describes how a job was created. Valid values are:.

notes

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

jobRunQueuingEnabled?optionalboolean | IResolvablejob_run_queuing_enabled?optionaltyping.Union[bool, IResolvable]jobRunQueuingEnabled?optionalBooleanJobRunQueuingEnabled?optionalboolJobRunQueuingEnabled?optionalinterface{}#

Specifies whether job run queuing is enabled for the job runs for this job.

notes

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.

logUri?optionalstringlog_uri?optionalstrlogUri?optionalStringLogUri?optionalstringLogUri?optional*string#

This field is reserved for future use.

maintenanceWindow?optionalstringmaintenance_window?optionalstrmaintenanceWindow?optionalStringMaintenanceWindow?optionalstringMaintenanceWindow?optional*string#

This field specifies a day of the week and hour for a maintenance window for streaming jobs.

notes

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.

maxCapacity?optionalnumbermax_capacity?optionalint | floatmaxCapacity?optionalNumberMaxCapacity?optionaldoubleMaxCapacity?optional*float64#

The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.

notes

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.

maxRetries?optionalnumbermax_retries?optionalint | floatmaxRetries?optionalNumberMaxRetries?optionaldoubleMaxRetries?optional*float64#

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

name?optionalstringname?optionalstrname?optionalStringName?optionalstringName?optional*string#

The name you assign to this job definition.

nonOverridableArguments?optionalanynon_overridable_arguments?optionalAnynonOverridableArguments?optionalObjectNonOverridableArguments?optionalobjectNonOverridableArguments?optionalinterface{}#

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

notificationProperty?optionalIResolvable | CfnJob.NotificationPropertyPropertynotification_property?optionaltyping.Union[IResolvable, NotificationPropertyProperty]notificationProperty?optionalIResolvableNotificationProperty?optionalIResolvableNotificationProperty?optionalinterface{}#

Specifies configuration properties of a notification.

numberOfWorkers?optionalnumbernumber_of_workers?optionalint | floatnumberOfWorkers?optionalNumberNumberOfWorkers?optionaldoubleNumberOfWorkers?optional*float64#

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 .

rolestring | IRoleRefroletyping.Union[str, IRoleRef]roleStringRolestringRoleinterface{}required#

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

securityConfiguration?optionalstringsecurity_configuration?optionalstrsecurityConfiguration?optionalStringSecurityConfiguration?optionalstringSecurityConfiguration?optional*string#

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

tags?optionalanytags?optionalAnytags?optionalObjectTags?optionalobjectTags?optionalinterface{}#

The tags to use with this job.

timeout?optionalnumbertimeout?optionalint | floattimeout?optionalNumberTimeout?optionaldoubleTimeout?optional*float64#

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

workerType?optionalstringworker_type?optionalstrworkerType?optionalStringWorkerType?optionalstringWorkerType?optional*string#

The type of predefined worker that is allocated when a job runs.

notes

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)