Package software.amazon.awscdk.services.glue

Interface SparkJobProps

All Superinterfaces:

JobProps, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

PySparkEtlJobProps, PySparkFlexEtlJobProps, PySparkStreamingJobProps, ScalaSparkEtlJobProps, ScalaSparkFlexEtlJobProps, ScalaSparkStreamingJobProps

All Known Implementing Classes:

PySparkEtlJobProps.Jsii$Proxy, PySparkFlexEtlJobProps.Jsii$Proxy, PySparkStreamingJobProps.Jsii$Proxy, ScalaSparkEtlJobProps.Jsii$Proxy, ScalaSparkFlexEtlJobProps.Jsii$Proxy, ScalaSparkStreamingJobProps.Jsii$Proxy, SparkJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-17T14:54:05.099Z")
@Stability(Stable)
public interface SparkJobProps
extends software.amazon.jsii.JsiiSerializable, JobProps

Common properties 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.*;
 import software.amazon.awscdk.services.glue.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.logs.*;
 import software.amazon.awscdk.services.s3.*;
 Bucket bucket;
 Code code;
 Connection connection;
 LogGroup logGroup;
 Role role;
 SecurityConfiguration securityConfiguration;
 SparkJobProps sparkJobProps = SparkJobProps.builder()
         .role(role)
         .script(code)
         // the properties below are optional
         .connections(List.of(connection))
         .continuousLogging(ContinuousLoggingProps.builder()
                 .enabled(false)
                 // the properties below are optional
                 .conversionPattern("conversionPattern")
                 .logGroup(logGroup)
                 .logStreamPrefix("logStreamPrefix")
                 .quiet(false)
                 .build())
         .defaultArguments(Map.of(
                 "defaultArgumentsKey", "defaultArguments"))
         .description("description")
         .enableMetrics(false)
         .enableObservabilityMetrics(false)
         .glueVersion(GlueVersion.V0_9)
         .jobName("jobName")
         .maxConcurrentRuns(123)
         .maxRetries(123)
         .securityConfiguration(securityConfiguration)
         .sparkUI(SparkUIProps.builder()
                 .bucket(bucket)
                 .prefix("prefix")
                 .build())
         .tags(Map.of(
                 "tagsKey", "tags"))
         .timeout(Duration.minutes(30))
         .workerConfiguration(WorkerConfiguration.builder()
                 .numberOfWorkers(123)
                 .workerType(WorkerType.STANDARD)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SparkJobProps.Builder	builder()
default Boolean	getEnableMetrics()	Enable profiling metrics for the Glue job.
default Boolean	getEnableObservabilityMetrics()	Enable observability metrics for the Glue job.
default SparkUIProps	getSparkUI()	Enables the Spark UI debugging and monitoring with the specified props.
default WorkerConfiguration	getWorkerConfiguration()	The worker type and the number of workers allocated when a job runs.

Methods inherited from interface software.amazon.awscdk.services.glue.JobProps

getConnections, getContinuousLogging, getDefaultArguments, getDescription, getGlueVersion, getJobName, getMaxConcurrentRuns, getMaxRetries, getRole, getScript, getSecurityConfiguration, getTags, getTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnableMetrics

@Stability(Stable)
@Nullable
default Boolean getEnableMetrics()

Enable profiling metrics for the Glue job.

When enabled, adds '--enable-metrics' to job arguments.

Default: true

getEnableObservabilityMetrics

@Stability(Stable)
@Nullable
default Boolean getEnableObservabilityMetrics()

Enable observability metrics for the Glue job.

When enabled, adds '--enable-observability-metrics': 'true' to job arguments.

Default: true

getSparkUI

@Stability(Stable)
@Nullable
default SparkUIProps getSparkUI()

Enables the Spark UI debugging and monitoring with the specified props.

Default: - Spark UI debugging and monitoring is disabled.

See Also:

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

getWorkerConfiguration

@Stability(Stable)
@Nullable
default WorkerConfiguration getWorkerConfiguration()

The worker type and the number of workers allocated when a job runs.

Default: - the job runs with the G_1X worker type and 10 workers.

builder

@Stability(Stable)
static SparkJobProps.Builder builder()

Returns:

a SparkJobProps.Builder of SparkJobProps