JobExecutableConfig

class aws_cdk.aws_glue_alpha.JobExecutableConfig(*, glue_version, language, script, type, class_name=None, extra_files=None, extra_jars=None, extra_jars_first=None, extra_python_files=None, python_version=None, runtime=None, s3_python_modules=None)

Bases: object

(experimental) Result of binding a JobExecutable into a Job.

Parameters:
  • glue_version (GlueVersion) – (experimental) Glue version.

  • language (JobLanguage) – (experimental) The language of the job (Scala or Python). Equivalent to a job parameter --job-language.

  • script (Code) – (experimental) The script that is executed by a job.

  • type (JobType) – (experimental) Specify the type of the job whether it’s an Apache Spark ETL or streaming one or if it’s a Python shell job.

  • class_name (Optional[str]) – (experimental) The Scala class that serves as the entry point for the job. This applies only if your the job langauage is Scala. Equivalent to a job parameter --class. Default: - no scala className specified

  • extra_files (Optional[Sequence[Code]]) – (experimental) Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it. Equivalent to a job parameter --extra-files. Default: - no extra files specified.

  • extra_jars (Optional[Sequence[Code]]) – (experimental) Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script. Equivalent to a job parameter --extra-jars. Default: - no extra jars specified.

  • extra_jars_first (Optional[bool]) – (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: - extra jars are not prioritized.

  • extra_python_files (Optional[Sequence[Code]]) – (experimental) Additional Python files that AWS Glue adds to the Python path before executing your script. Equivalent to a job parameter --extra-py-files. Default: - no extra python files specified.

  • python_version (Optional[PythonVersion]) – (experimental) The Python version to use. Default: - no python version specified

  • runtime (Optional[Runtime]) – (experimental) The Runtime to use. Default: - no runtime specified

  • s3_python_modules (Optional[Sequence[Code]]) – (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 specified.

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_glue_alpha as glue_alpha

# code: glue_alpha.Code
# glue_version: glue_alpha.GlueVersion
# job_type: glue_alpha.JobType
# runtime: glue_alpha.Runtime

job_executable_config = glue_alpha.JobExecutableConfig(
    glue_version=glue_version,
    language=glue_alpha.JobLanguage.SCALA,
    script=code,
    type=job_type,

    # the properties below are optional
    class_name="className",
    extra_files=[code],
    extra_jars=[code],
    extra_jars_first=False,
    extra_python_files=[code],
    python_version=glue_alpha.PythonVersion.TWO,
    runtime=runtime,
    s3_python_modules=[code]
)

Attributes

class_name

(experimental) The Scala class that serves as the entry point for the job.

This applies only if your the job langauage is Scala. Equivalent to a job parameter --class.

Default:
  • no scala className specified

See:

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

Stability:

experimental

extra_files

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

Equivalent to a job parameter --extra-files.

Default:
  • no extra files specified.

See:

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

Stability:

experimental

extra_jars

(experimental) Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script. Equivalent to a job parameter --extra-jars.

Default:
  • no extra jars specified.

See:

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

Stability:

experimental

extra_jars_first

(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:
  • extra jars are not prioritized.

See:

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

Stability:

experimental

extra_python_files

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

Equivalent to a job parameter --extra-py-files.

Default:
  • no extra python files specified.

See:

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

Stability:

experimental

glue_version

(experimental) Glue version.

See:

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

Stability:

experimental

language

(experimental) The language of the job (Scala or Python).

Equivalent to a job parameter --job-language.

See:

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

Stability:

experimental

python_version

(experimental) The Python version to use.

Default:
  • no python version specified

Stability:

experimental

runtime

(experimental) The Runtime to use.

Default:
  • no runtime specified

Stability:

experimental

s3_python_modules

(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 specified.

See:

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

Stability:

experimental

script

(experimental) The script that is executed by a job.

Stability:

experimental

type

(experimental) Specify the type of the job whether it’s an Apache Spark ETL or streaming one or if it’s a Python shell job.

Stability:

experimental