class CfnJob (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.Glue.CfnJob`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnJob`
Java	`software.amazon.awscdk.services.glue.CfnJob`
Python	`aws_cdk.aws_glue.CfnJob`
TypeScript	`aws-cdk-lib` » `aws_glue` » `CfnJob`

Implements IConstruct, IDependable, IInspectable, ITaggable

The AWS::Glue::Job resource specifies an AWS Glue job in the data catalog.

For more information, see Adding Jobs in AWS Glue and Job Structure in the AWS Glue Developer Guide.

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 cfnJob = new glue.CfnJob(this, 'MyCfnJob', {
  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',
});

Initializer

new CfnJob(scope: Construct, id: string, props: CfnJobProps)

Parameters

scope Construct — Scope in which this resource is defined.
id string — Construct identifier for this resource (unique in its scope).
props CfnJobProps — Resource properties.

Construct Props

Name	Type	Description
command	`IResolvable` `\|` `JobCommandProperty`	The code that executes a job.
role	`string`	The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
allocatedCapacity?	`number`	This parameter is no longer supported. Use `MaxCapacity` instead.
connections?	`IResolvable` `\|` `ConnectionsListProperty`	The connections used for this job.
defaultArguments?	`any`	The default arguments for this job, specified as name-value pairs.
description?	`string`	A description of the job.
executionClass?	`string`	Indicates whether the job is run with a standard or flexible execution class.
executionProperty?	`IResolvable` `\|` `ExecutionPropertyProperty`	The maximum number of concurrent runs that are allowed for this job.
glueVersion?	`string`	Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
jobMode?	`string`	A mode that describes how a job was created. Valid values are:.
jobRunQueuingEnabled?	`boolean \|` `IResolvable`	Specifies whether job run queuing is enabled for the job runs for this job.
logUri?	`string`	This field is reserved for future use.
maintenanceWindow?	`string`	This field specifies a day of the week and hour for a maintenance window for streaming jobs.
maxCapacity?	`number`	The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
maxRetries?	`number`	The maximum number of times to retry this job after a JobRun fails.
name?	`string`	The name you assign to this job definition.
nonOverridableArguments?	`any`	Non-overridable arguments for this job, specified as name-value pairs.
notificationProperty?	`IResolvable` `\|` `NotificationPropertyProperty`	Specifies configuration properties of a notification.
numberOfWorkers?	`number`	The number of workers of a defined `workerType` that are allocated when a job runs.
securityConfiguration?	`string`	The name of the `SecurityConfiguration` structure to be used with this job.
tags?	`any`	The tags to use with this job.
timeout?	`number`	The job timeout in minutes.
workerType?	`string`	The type of predefined worker that is allocated when a job runs.

command

Type: IResolvable | JobCommandProperty

The code that executes a job.

role

Type: string

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

allocatedCapacity?

Type: number (optional)

This parameter is no longer supported. Use MaxCapacity instead.

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

connections?

Type: IResolvable | ConnectionsListProperty (optional)

The connections used for this job.

defaultArguments?

Type: any (optional)

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 .

description?

Type: string (optional)

A description of the job.

executionClass?

Type: string (optional)

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.

executionProperty?

Type: IResolvable | ExecutionPropertyProperty (optional)

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

glueVersion?

Type: string (optional)

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.

jobMode?

Type: string (optional)

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.

jobRunQueuingEnabled?

Type: boolean | IResolvable (optional)

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.

logUri?

Type: string (optional)

This field is reserved for future use.

maintenanceWindow?

Type: string (optional)

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.

maxCapacity?

Type: number (optional)

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.

maxRetries?

Type: number (optional)

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

name?

Type: string (optional)

The name you assign to this job definition.

nonOverridableArguments?

Type: any (optional)

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

notificationProperty?

Type: IResolvable | NotificationPropertyProperty (optional)

Specifies configuration properties of a notification.

numberOfWorkers?

Type: number (optional)

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 .

securityConfiguration?

Type: string (optional)

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

tags?

Type: any (optional)

The tags to use with this job.

timeout?

Type: number (optional)

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?

Type: string (optional)

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

Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.

For the G.1X worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
For the G.4X worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs in the following AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
For the G.8X worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs, in the same AWS Regions as supported for the G.4X worker type.
For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for AWS Glue version 3.0 or later streaming jobs.
For the Z.2X worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.

Properties

Name	Type	Description
cfnOptions	`ICfnResourceOptions`	Options for this resource, such as condition, update policy etc.
cfnProperties	`{ [string]: any }`
cfnResourceType	`string`	AWS resource type.
command	`IResolvable` `\|` `JobCommandProperty`	The code that executes a job.
creationStack	`string[]`
logicalId	`string`	The logical ID for this CloudFormation stack element.
node	`Node`	The tree node.
ref	`string`	Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
role	`string`	The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
stack	`Stack`	The stack in which this element is defined.
tags	`TagManager`	Tag Manager which manages the tags for this resource.
allocatedCapacity?	`number`	This parameter is no longer supported.
connections?	`IResolvable` `\|` `ConnectionsListProperty`	The connections used for this job.
defaultArguments?	`any`	The default arguments for this job, specified as name-value pairs.
description?	`string`	A description of the job.
executionClass?	`string`	Indicates whether the job is run with a standard or flexible execution class.
executionProperty?	`IResolvable` `\|` `ExecutionPropertyProperty`	The maximum number of concurrent runs that are allowed for this job.
glueVersion?	`string`	Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
jobMode?	`string`	A mode that describes how a job was created.
jobRunQueuingEnabled?	`boolean \|` `IResolvable`	Specifies whether job run queuing is enabled for the job runs for this job.
logUri?	`string`	This field is reserved for future use.
maintenanceWindow?	`string`	This field specifies a day of the week and hour for a maintenance window for streaming jobs.
maxCapacity?	`number`	The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
maxRetries?	`number`	The maximum number of times to retry this job after a JobRun fails.
name?	`string`	The name you assign to this job definition.
nonOverridableArguments?	`any`	Non-overridable arguments for this job, specified as name-value pairs.
notificationProperty?	`IResolvable` `\|` `NotificationPropertyProperty`	Specifies configuration properties of a notification.
numberOfWorkers?	`number`	The number of workers of a defined `workerType` that are allocated when a job runs.
securityConfiguration?	`string`	The name of the `SecurityConfiguration` structure to be used with this job.
tagsRaw?	`any`	The tags to use with this job.
timeout?	`number`	The job timeout in minutes.
workerType?	`string`	The type of predefined worker that is allocated when a job runs.
static CFN_RESOURCE_TYPE_NAME	`string`	The CloudFormation resource type name for this resource class.

cfnOptions

Type: ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

cfnProperties

Type: { [string]: any }

cfnResourceType

Type: string

AWS resource type.

command

Type: IResolvable | JobCommandProperty

The code that executes a job.

creationStack

Type: string[]

logicalId

Type: string

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

node

Type: Node

The tree node.

ref

Type: string

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

role

Type: string

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

stack

Type: Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

allocatedCapacity?

Type: number (optional)

Methods

Name	Description
addDeletionOverride(path)	Syntactic sugar for `addOverride(path, undefined)`.
addDependency(target)	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addDependsOn(target)⚠️	Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)	Add a value to the CloudFormation Resource Metadata.
addOverride(path, value)	Adds an override to the synthesized CloudFormation resource.
addPropertyDeletionOverride(propertyPath)	Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)	Adds an override to a resource property.
applyRemovalPolicy(policy?, options?)	Sets the deletion policy of the resource based on the removal policy specified.
getAtt(attributeName, typeHint?)	Returns a token for an runtime attribute of this resource.
getMetadata(key)	Retrieve a value value from the CloudFormation Resource Metadata.
inspect(inspector)	Examines the CloudFormation resource and discloses attributes.
obtainDependencies()	Retrieves an array of resources this resource depends on.
obtainResourceDependencies()	Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)	Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)	Indicates that this resource no longer depends on another resource.
replaceDependency(target, newTarget)	Replaces one dependency with another.
toString()	Returns a string representation of this construct.
protected renderProperties(props)

addDeletionOverride(path)

public addDeletionOverride(path: string): void

Parameters

path string — The path of the value to delete.

Syntactic sugar for addOverride(path, undefined).

addDependency(target)

public addDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

addDependsOn(target)⚠️

public addDependsOn(target: CfnResource): void

⚠️ Deprecated: use addDependency

Parameters

target CfnResource

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

addMetadata(key, value)

public addMetadata(key: string, value: any): void

Parameters

key string
value any

Add a value to the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

addOverride(path, value)

public addOverride(path: string, value: any): void

Parameters

path string — - The path of the property, you can use dot notation to override values in complex types.
value any — - The value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

addPropertyDeletionOverride(propertyPath)

public addPropertyDeletionOverride(propertyPath: string): void

Parameters

propertyPath string — The path to the property.

Adds an override that deletes the value of a property from the resource definition.

addPropertyOverride(propertyPath, value)

public addPropertyOverride(propertyPath: string, value: any): void

Parameters

propertyPath string — The path of the property.
value any — The value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

applyRemovalPolicy(policy?, options?)

public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void

Parameters

policy RemovalPolicy
options RemovalPolicyOptions

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

getAtt(attributeName, typeHint?)

public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference

Parameters

attributeName string — The name of the attribute.
typeHint ResolutionTypeHint

Returns

Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

getMetadata(key)

public getMetadata(key: string): any

Parameters

key string

Returns

any

Retrieve a value value from the CloudFormation Resource Metadata.

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)

inspect(inspector)

public inspect(inspector: TreeInspector): void

Parameters

inspector TreeInspector — tree inspector to collect and process attributes.

Examines the CloudFormation resource and discloses attributes.

obtainDependencies()

public obtainDependencies(): Stack &#124; CfnResource[]

Returns

Stack | CfnResource[]

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

obtainResourceDependencies()

public obtainResourceDependencies(): CfnResource[]

Returns

CfnResource[]

Get a shallow copy of dependencies between this resource and other resources in the same stack.

overrideLogicalId(newLogicalId)

public overrideLogicalId(newLogicalId: string): void

Parameters

newLogicalId string — The new logical ID to use for this stack element.

Overrides the auto-generated logical ID with a specific ID.

removeDependency(target)

public removeDependency(target: CfnResource): void

Parameters

target CfnResource

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

replaceDependency(target, newTarget)

public replaceDependency(target: CfnResource, newTarget: CfnResource): void

Parameters

target CfnResource — The dependency to replace.
newTarget CfnResource — The new dependency to add.

Replaces one dependency with another.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

protected renderProperties(props)

protected renderProperties(props: { [string]: any }): { [string]: any }

Parameters

props { [string]: any }

Returns

{ [string]: any }