Package software.amazon.awscdk.services.glue

Class SparkJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.glue.JobBase

software.amazon.awscdk.services.glue.Job

software.amazon.awscdk.services.glue.SparkJob

All Implemented Interfaces:

IJobRef, IEnvironmentAware, IResource, IJob, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

PySparkEtlJob, PySparkFlexEtlJob, PySparkStreamingJob, ScalaSparkEtlJob, ScalaSparkFlexEtlJob, ScalaSparkStreamingJob

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-17T14:54:05.097Z")
@Stability(Stable)
public abstract class SparkJob
extends Job

Base class for different types of Spark Jobs.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 import software.amazon.awscdk.services.iam.*;
 Role role;
 IJob sparkJob = SparkJob.fromJobAttributes(this, "MySparkJob", JobAttributes.builder()
         .jobName("jobName")
         // the properties below are optional
         .role(role)
         .build());
 

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.glue.IJob

IJob.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SparkJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	SparkJob(software.amazon.jsii.JsiiObjectRef objRef)
protected	SparkJob(software.constructs.Construct scope, String id, SparkJobProps props)

Method Summary

Modifier and Type	Method	Description
IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
IRole	getRole()	The IAM role Glue assumes to run this job.
SparkUILoggingLocation	getSparkUILoggingLocation()	The Spark UI logs location if Spark UI monitoring and debugging is enabled.
protected void	nonExecutableCommonArguments(SparkJobProps props)	Register the arguments this construct manages for a Spark job.
protected void	setupExtraCodeArguments(SparkExtraCodeProps props)	Register the arguments for extra Code-related properties.

Methods inherited from class software.amazon.awscdk.services.glue.Job

codeS3ObjectUrl, fromJobAttributes, mergeDefaultArguments, mergeDefaultArguments, setManagedArgument, setManagedArgument, setupContinuousLogging, setupContinuousLogging, setupContinuousLogging

Methods inherited from class software.amazon.awscdk.services.glue.JobBase

buildJobArn, getJobArn, getJobName, getJobRef, metric, metric, metricFailure, metricFailure, metricSuccess, metricSuccess, metricTimeout, metricTimeout, onEvent, onEvent, onFailure, onFailure, onStateChange, onStateChange, onSuccess, onSuccess, onTimeout, onTimeout

Methods inherited from class software.amazon.awscdk.Resource

applyCrossStackReferenceStrength, applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource, with

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode, with

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

SparkJob

protected SparkJob(software.amazon.jsii.JsiiObjectRef objRef)

SparkJob

protected SparkJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

SparkJob

@Stability(Stable)
protected SparkJob(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 SparkJobProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Details

nonExecutableCommonArguments

@Stability(Stable)
protected void nonExecutableCommonArguments(@NotNull
 SparkJobProps props)

Register the arguments this construct manages for a Spark job.

These are owned by the construct (derived from typed props). Each key is declared via Job.setManagedArgument(java.lang.String,java.lang.String) whether or not the current configuration emits a value, so a disabled feature (e.g. `enableMetrics: false`) cannot be silently re-enabled through `defaultArguments`.

Parameters:

props - This parameter is required.

setupExtraCodeArguments

@Stability(Stable)
protected void setupExtraCodeArguments(@NotNull
 SparkExtraCodeProps props)

Register the arguments for extra Code-related properties.

Parameters:

props - This parameter is required.

getGrantPrincipal

@Stability(Stable)
@NotNull
public IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in class JobBase

getRole

@Stability(Stable)
@NotNull
public IRole getRole()

The IAM role Glue assumes to run this job.

Specified by:

getRole in class Job

getSparkUILoggingLocation

@Stability(Stable)
@Nullable
public SparkUILoggingLocation getSparkUILoggingLocation()

The Spark UI logs location if Spark UI monitoring and debugging is enabled.

See Also:

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