interface RayJobProps ⚠️

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

⚠️ 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 JobProps

Properties for creating a Ray Glue job.

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 rayJobProps: glue_alpha.RayJobProps = {
  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,
};

Properties

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

AWS CDK

2.258.1