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

Class SparkJob

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.glue.alpha.JobBase

software.amazon.awscdk.services.glue.alpha.Job

software.amazon.awscdk.services.glue.alpha.SparkJob

All Implemented Interfaces:

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.112.0 (build de1bc80)",
           date="2025-07-04T12:43:18.274Z")
@Stability(Experimental)
public abstract class SparkJob
extends Job

(experimental) 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.alpha.*;
 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.alpha.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()	(experimental) The principal to grant permissions to.
IRole	getRole()	(experimental) The IAM role Glue assumes to run this job.
SparkUILoggingLocation	getSparkUILoggingLocation()	(experimental) The Spark UI logs location if Spark UI monitoring and debugging is enabled.
protected Map<String,String>	nonExecutableCommonArguments(SparkJobProps props)
protected void	setupExtraCodeArguments(Map<String,String> args, SparkExtraCodeProps props)	(experimental) Set the arguments for extra Code-related properties.

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

checkNoReservedArgs, checkNoReservedArgs, codeS3ObjectUrl, fromJobAttributes, setupContinuousLogging, setupContinuousLogging

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

buildJobArn, getJobArn, getJobName, 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

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

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

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, 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(Experimental)
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(Experimental)
@NotNull
protected Map<String,String> nonExecutableCommonArguments(@NotNull
 SparkJobProps props)

Parameters:

props - This parameter is required.

setupExtraCodeArguments

@Stability(Experimental)
protected void setupExtraCodeArguments(@NotNull
 Map<String,String> args,
 @NotNull
 SparkExtraCodeProps props)

(experimental) Set the arguments for extra Code-related properties.

Parameters:

args - This parameter is required.

props - This parameter is required.

getGrantPrincipal

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

(experimental) The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in class JobBase

getRole

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

(experimental) The IAM role Glue assumes to run this job.

Specified by:

getRole in class Job

getSparkUILoggingLocation

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

(experimental) 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