JobExecutableConfig

class aws_cdk.aws_glue.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)

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

  • 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. 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. 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. 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. 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. Default: - no extra python files specified.

  • python_version (Optional[PythonVersion]) – (experimental) The Python version to use. Default: - no python version 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 as glue

# code: glue.Code
# glue_version: glue.GlueVersion
# job_type: glue.JobType

job_executable_config = glue.JobExecutableConfig(
    glue_version=glue_version,
    language=glue.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.PythonVersion.TWO
)

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.

Default

  • no scala className specified

See

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

Stability

experimental

Return type

Optional[str]

extra_files

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

Default

  • no extra files specified.

See

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

Stability

experimental

Return type

Optional[List[Code]]

extra_jars

(experimental) Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script.

Default

  • no extra jars specified.

See

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

Stability

experimental

Return type

Optional[List[Code]]

extra_jars_first

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

Default

  • extra jars are not prioritized.

See

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

Stability

experimental

Return type

Optional[bool]

extra_python_files

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

Default

  • no extra python files specified.

See

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

Stability

experimental

Return type

Optional[List[Code]]

glue_version

(experimental) Glue version.

See

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

Stability

experimental

Return type

GlueVersion

language

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

See

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

Stability

experimental

Return type

JobLanguage

python_version

(experimental) The Python version to use.

Default

  • no python version specified

Stability

experimental

Return type

Optional[PythonVersion]

script

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

Stability

experimental

Return type

Code

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

Return type

JobType