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

Interface PythonRayExecutableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PythonRayExecutableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:11.584Z")
@Stability(Experimental)
public interface PythonRayExecutableProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Props for creating a Python Ray job executable.

Example:

 Job.Builder.create(this, "RayJob")
         .executable(JobExecutable.pythonRay(PythonRayExecutableProps.builder()
                 .glueVersion(GlueVersion.V4_0)
                 .pythonVersion(PythonVersion.THREE_NINE)
                 .runtime(Runtime.RAY_TWO_FOUR)
                 .script(Code.fromAsset(join(__dirname, "job-script", "hello_world.py")))
                 .build()))
         .workerType(WorkerType.Z_2X)
         .workerCount(2)
         .description("an example Ray job")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PythonRayExecutableProps.Builder	builder()
default List<Code>	getExtraFiles()	(experimental) Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.
GlueVersion	getGlueVersion()	(experimental) Glue version.
PythonVersion	getPythonVersion()	(experimental) The Python version to use.
default Runtime	getRuntime()	(experimental) Runtime.
default List<Code>	getS3PythonModules()	(experimental) Additional Python modules that AWS Glue adds to the Python path before executing your script.
Code	getScript()	(experimental) The script that executes a job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getGlueVersion

@Stability(Experimental)
@NotNull
GlueVersion getGlueVersion()

(experimental) Glue version.

See Also:

• https://docs.aws.amazon.com/glue/latest/dg/release-notes.html

getPythonVersion

@Stability(Experimental)
@NotNull
PythonVersion getPythonVersion()

(experimental) The Python version to use.

getScript

@Stability(Experimental)
@NotNull
Code getScript()

(experimental) The script that executes a job.

getExtraFiles

@Stability(Experimental)
@Nullable
default List<Code> getExtraFiles()

(experimental) Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.

Only individual files are supported, directories are not supported. Equivalent to a job parameter --extra-files.

Default: [] - no extra files are copied to the working directory

See Also:

• https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

getRuntime

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

(experimental) Runtime.

It is required for Ray jobs.

getS3PythonModules

@Stability(Experimental)
@Nullable
default List<Code> getS3PythonModules()

(experimental) Additional Python modules that AWS Glue adds to the Python path before executing your script.

Equivalent to a job parameter --s3-py-modules.

Default: - no extra python files and argument is not set

See Also:

• https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html

builder

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

Returns:

a PythonRayExecutableProps.Builder of PythonRayExecutableProps