class RayJob (construct) ⚠️

Language	Type name
.NET	`Amazon.CDK.AWS.Glue.Alpha.RayJob`
Go	`github.com/aws/aws-cdk-go/awscdkgluealpha/v2#RayJob`
Java	`software.amazon.awscdk.services.glue.alpha.RayJob`
Python	`aws_cdk.aws_glue_alpha.RayJob`
TypeScript (source)	`@aws-cdk/aws-glue-alpha` » `RayJob`

⚠️ Deprecated: AWS Glue for Ray is closed to new customers as of April 30, 2026. Migrate to Amazon EKS with KubeRay Operator. See https://docs.aws.amazon.com/glue/latest/dg/awsglue-ray-jobs-availability-change.html

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IJob, IGrantable

Ray Jobs class.

Glue Ray jobs use worker type Z.2X and Glue version 4.0. These are not overrideable since these are the only configuration that Glue Ray jobs currently support. The runtime defaults to Ray2.4 and min workers defaults to 3.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as glue_alpha from '@aws-cdk/aws-glue-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_logs as logs } from 'aws-cdk-lib';

declare const code: glue_alpha.Code;
declare const connection: glue_alpha.Connection;
declare const logGroup: logs.LogGroup;
declare const role: iam.Role;
declare const securityConfiguration: glue_alpha.SecurityConfiguration;
const rayJob = new glue_alpha.RayJob(this, 'MyRayJob', {
  role: role,
  script: code,

  // the properties below are optional
  connections: [connection],
  continuousLogging: {
    enabled: false,

    // the properties below are optional
    conversionPattern: 'conversionPattern',
    logGroup: logGroup,
    logStreamPrefix: 'logStreamPrefix',
    quiet: false,
  },
  defaultArguments: {
    defaultArgumentsKey: 'defaultArguments',
  },
  description: 'description',
  enableMetrics: false,
  enableObservabilityMetrics: false,
  enableProfilingMetrics: false,
  glueVersion: glue_alpha.GlueVersion.V0_9,
  jobName: 'jobName',
  jobRunQueuingEnabled: false,
  maxConcurrentRuns: 123,
  maxRetries: 123,
  numberOfWorkers: 123,
  runtime: glue_alpha.Runtime.RAY_TWO_FOUR,
  securityConfiguration: securityConfiguration,
  tags: {
    tagsKey: 'tags',
  },
  timeout: cdk.Duration.minutes(30),
  workerType: glue_alpha.WorkerType.STANDARD,
});

Initializer

new RayJob(scope: Construct, id: string, props: RayJobProps)

Parameters

scope Construct
id string
props RayJobProps

RayJob constructor.

Construct Props

Name	Type	Description
role⚠️	`IRole`	IAM Role (required) IAM Role to use for Glue job execution Must be specified by the developer because the L2 doesn't have visibility into the actions the script(s) takes during the job execution The role must trust the Glue service principal (glue.amazonaws.com) and be granted sufficient permissions.
script⚠️	`Code`	Script Code Location (required) Script to run when the Glue job executes.
connections?⚠️	`IConnection[]`	Connections (optional) List of connections to use for this Glue job Connections are used to connect to other AWS Service or resources within a VPC.
continuousLogging?⚠️	`ContinuousLoggingProps`	Enables continuous logging with the specified props.
defaultArguments?⚠️	`{ [string]: string }`	Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs.
description?⚠️	`string`	Description (optional) Developer-specified description of the Glue job.
enableMetrics?⚠️	`boolean`	Enable profiling metrics for the Glue job.
enableObservabilityMetrics?⚠️	`boolean`	Enable observability metrics for the Glue job.
enableProfilingMetrics?⚠️	`boolean`	Enables the collection of metrics for job profiling.
glueVersion?⚠️	`GlueVersion`	Glue Version The version of Glue to use to execute this job.
jobName?⚠️	`string`	Name of the Glue job (optional) Developer-specified name of the Glue job.
jobRunQueuingEnabled?⚠️	`boolean`	Specifies whether job run queuing is enabled for the job runs for this job.
maxConcurrentRuns?⚠️	`number`	Max Concurrent Runs (optional) The maximum number of runs this Glue job can concurrently run.
maxRetries?⚠️	`number`	Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails.
numberOfWorkers?⚠️	`number`	Number of Workers (optional) Number of workers for Glue to use during job execution.
runtime?⚠️	`Runtime`	Sets the Ray runtime environment version.
securityConfiguration?⚠️	`ISecurityConfiguration`	Security Configuration (optional) Defines the encryption options for the Glue job.
tags?⚠️	`{ [string]: string }`	Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources.
timeout?⚠️	`Duration`	Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
workerType?⚠️	`WorkerType`	Worker Type (optional) Type of Worker for Glue to use during job execution Enum options: Standard, G_1X, G_2X, G_025X.

role⚠️

Type: IRole

IAM Role (required) IAM Role to use for Glue job execution Must be specified by the developer because the L2 doesn't have visibility into the actions the script(s) takes during the job execution The role must trust the Glue service principal (glue.amazonaws.com) and be granted sufficient permissions.

script⚠️

Type: Code

Script Code Location (required) Script to run when the Glue job executes.

Can be uploaded from the local directory structure using fromAsset or referenced via S3 location using fromBucket

connections?⚠️

Type: IConnection[] (optional, default: [] - no connections are added to the job)

Connections (optional) List of connections to use for this Glue job Connections are used to connect to other AWS Service or resources within a VPC.

continuousLogging?⚠️

Type: ContinuousLoggingProps (optional, default: continuous logging is enabled.)

Enables continuous logging with the specified props.

defaultArguments?⚠️

Type: { [string]: string } (optional, default: no arguments)

Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs.

description?⚠️

Type: string (optional, default: no value)

Description (optional) Developer-specified description of the Glue job.

enableMetrics?⚠️

Type: boolean (optional, default: true)

Enable profiling metrics for the Glue job.

When enabled, adds '--enable-metrics' to job arguments.

enableObservabilityMetrics?⚠️

Type: boolean (optional, default: true)

Enable observability metrics for the Glue job.

When enabled, adds '--enable-observability-metrics': 'true' to job arguments.

enableProfilingMetrics?⚠️

Type: boolean (optional, default: no profiling metrics emitted.)

Enables the collection of metrics for job profiling.

glueVersion?⚠️

Type: GlueVersion (optional, default: 3.0 for ETL)

Glue Version The version of Glue to use to execute this job.

jobName?⚠️

Type: string (optional, default: a name is automatically generated)

Name of the Glue job (optional) Developer-specified name of the Glue job.

jobRunQueuingEnabled?⚠️

Type: boolean (optional, default: no job run queuing)

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. This property must be set to false for flex jobs. If this property is enabled, maxRetries must be set to zero.

maxConcurrentRuns?⚠️

Type: number (optional, default: 1)

Max Concurrent Runs (optional) The maximum number of runs this Glue job can concurrently run.

An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.

maxRetries?⚠️

Type: number (optional, default: 0)

Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails.

numberOfWorkers?⚠️

Type: number (optional, default: 10)

Number of Workers (optional) Number of workers for Glue to use during job execution.

runtime?⚠️

Type: Runtime (optional, default: Runtime version will default to Ray2.4)

Sets the Ray runtime environment version.

securityConfiguration?⚠️

Type: ISecurityConfiguration (optional, default: no security configuration.)

Security Configuration (optional) Defines the encryption options for the Glue job.

tags?⚠️

Type: { [string]: string } (optional, default: {} - no tags)

Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources.

timeout?⚠️

Type: Duration (optional, default: 2880 (2 days for non-streaming))

Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.

Specified in minutes.

workerType?⚠️

Type: WorkerType (optional, default: WorkerType.G_1X)

Worker Type (optional) Type of Worker for Glue to use during job execution Enum options: Standard, G_1X, G_2X, G_025X.

G_4X, G_8X, Z_2X

Properties

Name	Type	Description
env⚠️	`ResourceEnvironment`	The environment this resource belongs to.
grantPrincipal⚠️	`IPrincipal`	The principal to grant permissions to.
jobArn⚠️	`string`	The ARN of the job.
jobName⚠️	`string`	The name of the job.
node⚠️	`Node`	The tree node.
role⚠️	`IRole`	The IAM role Glue assumes to run this job.
stack⚠️	`Stack`	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID⚠️	`string`	Uniquely identifies this class.

env⚠️

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grantPrincipal⚠️

Type: IPrincipal

The principal to grant permissions to.

jobArn⚠️

Type: string

The ARN of the job.

jobName⚠️

Type: string

The name of the job.

node⚠️

Type: Node

The tree node.

role⚠️

Type: IRole

The IAM role Glue assumes to run this job.

stack⚠️

Type: Stack

The stack in which this resource is defined.

static PROPERTY_INJECTION_ID⚠️

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyCrossStackReferenceStrength(strength)⚠️	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)⚠️	Apply the given removal policy to this resource.
metric(metricName, type, props?)⚠️	Create a CloudWatch metric.
metricFailure(props?)⚠️	Return a CloudWatch Metric indicating job failure.
metricSuccess(props?)⚠️	Return a CloudWatch Metric indicating job success.
metricTimeout(props?)⚠️	Return a CloudWatch Metric indicating job timeout.
onEvent(id, options?)⚠️	Create a CloudWatch Event Rule for this Glue Job when it's in a given state.
onFailure(id, options?)⚠️	Return a CloudWatch Event Rule matching FAILED state.
onSuccess(id, options?)⚠️	Create a CloudWatch Event Rule matching JobState.SUCCEEDED.
onTimeout(id, options?)⚠️	Return a CloudWatch Event Rule matching TIMEOUT state.
toString()⚠️	Returns a string representation of this construct.
with(...mixins)⚠️	Applies one or more mixins to this construct.

applyCrossStackReferenceStrength(strength)⚠️

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

applyRemovalPolicy(policy)⚠️

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

Apply the given removal policy to this resource.

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

metric(metricName, type, props?)⚠️

public metric(metricName: string, type: MetricType, props?: MetricOptions): Metric

Parameters

metricName string — name of the metric typically prefixed with glue.driver., glue.<executorId>. or glue.ALL..
type MetricType — the metric type.
props MetricOptions — metric options.

Returns

Metric

Create a CloudWatch metric.

metricFailure(props?)⚠️

public metricFailure(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Return a CloudWatch Metric indicating job failure.

This metric is based on the Rule returned by no-args onFailure() call.

metricSuccess(props?)⚠️

public metricSuccess(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Return a CloudWatch Metric indicating job success.

This metric is based on the Rule returned by no-args onSuccess() call.

metricTimeout(props?)⚠️

public metricTimeout(props?: MetricOptions): Metric

Parameters

props MetricOptions

Returns

Metric

Return a CloudWatch Metric indicating job timeout.

This metric is based on the Rule returned by no-args onTimeout() call.

onEvent(id, options?)⚠️

public onEvent(id: string, options?: OnEventOptions): Rule

Parameters

id string — construct id.
options OnEventOptions — event options.

Returns

Rule

Create a CloudWatch Event Rule for this Glue Job when it's in a given state.

onFailure(id, options?)⚠️

public onFailure(id: string, options?: OnEventOptions): Rule

Parameters

id string — construct id.
options OnEventOptions — optional event options.

Returns

Rule

Return a CloudWatch Event Rule matching FAILED state.

onSuccess(id, options?)⚠️

public onSuccess(id: string, options?: OnEventOptions): Rule

Parameters

id string — construct id.
options OnEventOptions — optional event options.

Returns

Rule

Create a CloudWatch Event Rule matching JobState.SUCCEEDED.

onTimeout(id, options?)⚠️

public onTimeout(id: string, options?: OnEventOptions): Rule

Parameters

id string — construct id.
options OnEventOptions — optional event options.

Returns

Rule

Return a CloudWatch Event Rule matching TIMEOUT state.

toString()⚠️

public toString(): string

Returns

string

Returns a string representation of this construct.

with(...mixins)⚠️

public with(...mixins: IMixin[]): IConstruct

Parameters

mixins IMixin

Returns

IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.