Show / Hide Table of Contents

Class RayJob

(deprecated) Ray Jobs class.

Inheritance
object
Resource
JobBase
Job
RayJob
Implements
IJob
IResource
IConstruct
IDependable
IEnvironmentAware
IGrantable
Inherited Members
Job.FromJobAttributes(Construct, string, IJobAttributes)
Job.CheckNoReservedArgs(IDictionary<string, string>)
Job.CodeS3ObjectUrl(Code)
Job.SetupContinuousLogging(IRole, IContinuousLoggingProps)
JobBase.BuildJobArn(Construct, string)
JobBase.Metric(string, MetricType, IMetricOptions)
JobBase.MetricFailure(IMetricOptions)
JobBase.MetricSuccess(IMetricOptions)
JobBase.MetricTimeout(IMetricOptions)
JobBase.OnEvent(string, IOnEventOptions)
JobBase.OnFailure(string, IOnEventOptions)
JobBase.OnStateChange(string, JobState, IOnEventOptions)
JobBase.OnSuccess(string, IOnEventOptions)
JobBase.OnTimeout(string, IOnEventOptions)
Resource.IsOwnedResource(IConstruct)
Resource.IsResource(IConstruct)
Resource.ApplyCrossStackReferenceStrength(ReferenceStrength)
Resource.ApplyRemovalPolicy(RemovalPolicy)
Resource.GeneratePhysicalName()
Resource.GetResourceArnAttribute(string, IArnComponents)
Resource.GetResourceNameAttribute(string)
Resource.With(params IMixin[])
Resource.Env
Resource.PhysicalName
Resource.Stack
Namespace: Amazon.CDK.AWS.Glue.Alpha
Assembly: Amazon.CDK.AWS.Glue.Alpha.dll
Syntax (csharp)
[Obsolete("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")]
public class RayJob : Job, IJob, IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable
Syntax (vb)
<Obsolete("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")>
Public Class RayJob Inherits Job Implements IJob, IResource, IConstruct, IDependable, IEnvironmentAware, IGrantable
Remarks

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.

Stability: Deprecated

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Glue.Alpha;
             using Amazon.CDK;
             using Amazon.CDK.AWS.IAM;
             using Amazon.CDK.AWS.Logs;

             Code code;
             Connection connection;
             LogGroup logGroup;
             Role role;
             SecurityConfiguration securityConfiguration;

             var rayJob = new RayJob(this, "MyRayJob", new RayJobProps {
                 Role = role,
                 Script = code,

                 // the properties below are optional
                 Connections = new [] { connection },
                 ContinuousLogging = new ContinuousLoggingProps {
                     Enabled = false,

                     // the properties below are optional
                     ConversionPattern = "conversionPattern",
                     LogGroup = logGroup,
                     LogStreamPrefix = "logStreamPrefix",
                     Quiet = false
                 },
                 DefaultArguments = new Dictionary<string, string> {
                     { "defaultArgumentsKey", "defaultArguments" }
                 },
                 Description = "description",
                 EnableMetrics = false,
                 EnableObservabilityMetrics = false,
                 EnableProfilingMetrics = false,
                 GlueVersion = GlueVersion.V0_9,
                 JobName = "jobName",
                 JobRunQueuingEnabled = false,
                 MaxConcurrentRuns = 123,
                 MaxRetries = 123,
                 NumberOfWorkers = 123,
                 Runtime = Runtime.RAY_TWO_FOUR,
                 SecurityConfiguration = securityConfiguration,
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 Timeout = Duration.Minutes(30),
                 WorkerType = WorkerType.STANDARD
             });

Synopsis

Constructors

RayJob(Construct, string, IRayJobProps)

(deprecated) RayJob constructor.

Properties

GrantPrincipal

(deprecated) The principal to grant permissions to.

JobArn

(deprecated) The ARN of the job.

JobName

(deprecated) The name of the job.

PROPERTY_INJECTION_ID

(deprecated) Uniquely identifies this class.

Role

(deprecated) The IAM role Glue assumes to run this job.

Constructors

RayJob(Construct, string, IRayJobProps)

(deprecated) RayJob constructor.

[Obsolete]
public RayJob(Construct scope, string id, IRayJobProps props)
Parameters
scope Construct
id string
props IRayJobProps
Remarks

Stability: Deprecated

Properties

GrantPrincipal

(deprecated) The principal to grant permissions to.

[Obsolete]
public override IPrincipal GrantPrincipal { get; }
Property Value

IPrincipal

Overrides
JobBase.GrantPrincipal
Remarks

Stability: Deprecated

JobArn

(deprecated) The ARN of the job.

[Obsolete]
public override string JobArn { get; }
Property Value

string

Overrides
JobBase.JobArn
Remarks

Stability: Deprecated

JobName

(deprecated) The name of the job.

[Obsolete]
public override string JobName { get; }
Property Value

string

Overrides
JobBase.JobName
Remarks

Stability: Deprecated

PROPERTY_INJECTION_ID

(deprecated) Uniquely identifies this class.

[Obsolete]
public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Stability: Deprecated

Role

(deprecated) The IAM role Glue assumes to run this job.

[Obsolete]
public override IRole Role { get; }
Property Value

IRole

Overrides
Job.Role
Remarks

Stability: Deprecated

Implements

IJob
IResource
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
IGrantable
Back to top Generated by DocFX