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

Interface PythonSparkJobExecutableProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PythonSparkJobExecutableProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:15.784Z")
@Stability(Experimental)
public interface PythonSparkJobExecutableProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Props for creating a Python Spark (ETL or Streaming) job executable.

Example:

 Job.Builder.create(this, "PythonSparkStreamingJob")
         .executable(JobExecutable.pythonStreaming(PythonSparkJobExecutableProps.builder()
                 .glueVersion(GlueVersion.V4_0)
                 .pythonVersion(PythonVersion.THREE)
                 .script(Code.fromAsset(join(__dirname, "job-script", "hello_world.py")))
                 .build()))
         .description("an example Python Streaming job")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PythonSparkJobExecutableProps.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.
default List<Code>	getExtraJars()	(experimental) Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script.
default Boolean	getExtraJarsFirst()	(experimental) Setting this value to true prioritizes the customer's extra JAR files in the classpath.
default List<Code>	getExtraPythonFiles()	(experimental) Additional Python files that AWS Glue adds to the Python path before executing your script.
GlueVersion	getGlueVersion()	(experimental) Glue version.
PythonVersion	getPythonVersion()	(experimental) The Python version to use.
default Runtime	getRuntime()	(experimental) Runtime.
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

getExtraJars

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

(experimental) Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script. Only individual files are supported, directories are not supported. Equivalent to a job parameter --extra-jars.

Default: [] - no extra jars are added to the classpath

See Also:

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

getExtraJarsFirst

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

(experimental) Setting this value to true prioritizes the customer's extra JAR files in the classpath.

Equivalent to a job parameter --user-jars-first.

Default: false - priority is not given to user-provided jars

See Also:

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

getExtraPythonFiles

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

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

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

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

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.

builder

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

Returns:

a PythonSparkJobExecutableProps.Builder of PythonSparkJobExecutableProps