Package software.amazon.awscdk.services.glue.alpha

Interface RayJobProps

All Superinterfaces:

JobProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RayJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:41:04.915Z")
@Stability(Experimental)
public interface RayJobProps
extends software.amazon.jsii.JsiiSerializable, JobProps

(experimental) Properties for creating a Ray Glue job.

Example:

 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.iam.*;
 Stack stack;
 IRole role;
 Code script;
 RayJob.Builder.create(stack, "ImportedJob").role(role).script(script).build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	RayJobProps.Builder	A builder for RayJobProps
static final class	RayJobProps.Jsii$Proxy	An implementation for RayJobProps

Method Summary

Modifier and Type	Method	Description
static RayJobProps.Builder	builder()
default Boolean	getEnableMetrics()	(experimental) Enable profiling metrics for the Glue job.
default Boolean	getEnableObservabilityMetrics()	(experimental) Enable observability metrics for the Glue job.
default Boolean	getJobRunQueuingEnabled()	(experimental) Specifies whether job run queuing is enabled for the job runs for this job.
default Runtime	getRuntime()	(experimental) Sets the Ray runtime environment version.

Methods inherited from interface software.amazon.awscdk.services.glue.alpha.JobProps

getConnections, getContinuousLogging, getDefaultArguments, getDescription, getEnableProfilingMetrics, getGlueVersion, getJobName, getMaxConcurrentRuns, getMaxRetries, getNumberOfWorkers, getRole, getScript, getSecurityConfiguration, getTags, getTimeout, getWorkerType

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnableMetrics

@Stability(Experimental)
@Nullable
default Boolean getEnableMetrics()

(experimental) Enable profiling metrics for the Glue job.

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

Default: true

getEnableObservabilityMetrics

@Stability(Experimental)
@Nullable
default Boolean getEnableObservabilityMetrics()

(experimental) Enable observability metrics for the Glue job.

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

Default: true

getJobRunQueuingEnabled

@Stability(Experimental)
@Nullable
default Boolean getJobRunQueuingEnabled()

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

Default: - no job run queuing

getRuntime

@Stability(Experimental)
@Nullable
default Runtime getRuntime()

(experimental) Sets the Ray runtime environment version.

Default: - Runtime version will default to Ray2.4

builder

@Stability(Experimental)
static RayJobProps.Builder builder()

Returns:

a RayJobProps.Builder of RayJobProps