All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:: PySparkEtlJobProps, PySparkFlexEtlJobProps, PySparkStreamingJobProps, PythonShellJobProps, ScalaSparkEtlJobProps, ScalaSparkFlexEtlJobProps, ScalaSparkStreamingJobProps, SparkJobProps

All Known Implementing Classes:: JobProps.Jsii$Proxy, PySparkEtlJobProps.Jsii$Proxy, PySparkFlexEtlJobProps.Jsii$Proxy, PySparkStreamingJobProps.Jsii$Proxy, PythonShellJobProps.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.055Z") @Stability(Stable) public interface JobProps extends software.amazon.jsii.JsiiSerializable

JobProps will be used to create new Glue Jobs using this L2 Construct.

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.*;
 Code code;
 Connection connection;
 LogGroup logGroup;
 Role role;
 SecurityConfiguration securityConfiguration;
 JobProps jobProps = JobProps.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")
         .glueVersion(GlueVersion.V0_9)
         .jobName("jobName")
         .maxConcurrentRuns(123)
         .maxRetries(123)
         .securityConfiguration(securityConfiguration)
         .tags(Map.of(
                 "tagsKey", "tags"))
         .timeout(Duration.minutes(30))
         .build();

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

JobProps.Builder

A builder for JobProps

static final class

JobProps.Jsii$Proxy

An implementation for JobProps
Method Summary

Modifier and Type

Method

Description

static JobProps.Builder

builder()

default List<IConnection>

getConnections()

Connections (optional) List of connections to use for this Glue job Connections are used to connect to other AWS Service or resources within a VPC.

default ContinuousLoggingProps

getContinuousLogging()

Enables continuous logging with the specified props.

default Map<String,String>

getDefaultArguments()

Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs.

default String

getDescription()

Description (optional) Developer-specified description of the Glue job.

default GlueVersion

getGlueVersion()

Glue Version The version of Glue to use to execute this job.

default String

getJobName()

Name of the Glue job (optional) Developer-specified name of the Glue job.

default Number

getMaxConcurrentRuns()

Max Concurrent Runs (optional) The maximum number of runs this Glue job can concurrently run.

default Number

getMaxRetries()

Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails.

IRole

getRole()

IAM Role (required) IAM Role to use for Glue job execution Must be specified by the developer because the L2 doesn't have visibility into the actions the script(s) takes during the job execution The role must trust the Glue service principal (glue.amazonaws.com) and be granted sufficient permissions.

Code

getScript()

Script Code Location (required) Script to run when the Glue job executes.

default ISecurityConfiguration

getSecurityConfiguration()

Security Configuration (optional) Defines the encryption options for the Glue job.

default Map<String,String>

getTags()

Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources.

default Duration

getTimeout()

Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getRole
  
  @Stability(Stable) @NotNull IRole getRole()
  
  IAM Role (required) IAM Role to use for Glue job execution Must be specified by the developer because the L2 doesn't have visibility into the actions the script(s) takes during the job execution The role must trust the Glue service principal (glue.amazonaws.com) and be granted sufficient permissions.
  See Also:
  
  https://docs.aws.amazon.com/glue/latest/dg/getting-started-access.html
- getScript
  
  @Stability(Stable) @NotNull Code getScript()
  
  Script Code Location (required) Script to run when the Glue job executes.
  Can be uploaded from the local directory structure using fromAsset or referenced via S3 location using fromBucket
- getConnections
  
  @Stability(Stable) @Nullable default List<IConnection> getConnections()
  
  Connections (optional) List of connections to use for this Glue job Connections are used to connect to other AWS Service or resources within a VPC.
  Default: [] - no connections are added to the job
- getContinuousLogging
  
  @Stability(Stable) @Nullable default ContinuousLoggingProps getContinuousLogging()
  
  Enables continuous logging with the specified props.
  Default: - continuous logging is enabled.
  See Also:
  
  https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
- getDefaultArguments
  
  @Stability(Stable) @Nullable default Map<String,String> getDefaultArguments()
  
  Default Arguments (optional) The default arguments for every run of this Glue job, specified as name-value pairs.
  This map is the escape hatch for Glue job arguments that this construct does not model. It MUST NOT be used to set arguments that already have a dedicated prop — configure those through the corresponding prop instead (continuousLogging, enableMetrics, enableObservabilityMetrics, sparkUI, className, extraJars, extraJarsFirst, extraPythonFiles, extraFiles). Passing a construct-managed argument (e.g. --enable-continuous-cloudwatch-log, --enable-metrics, --enable-spark-ui, --job-language) or a Glue-reserved argument (--debug, --mode, --JOB_NAME, --endpoint) here throws at synthesis time, so there is exactly one way to express each intent.
  Also note that these are emitted verbatim into the CloudFormation template, so avoid placing secrets here in plaintext. Pass secrets to the job at runtime through AWS Secrets Manager instead. A synthesis-time warning is emitted when an argument key looks like a credential and holds a plaintext literal.
  Default: - no arguments
  See Also:
  
  https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html for a list of reserved parameters
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  Description (optional) Developer-specified description of the Glue job.
  Default: - no value
- getGlueVersion
  
  @Stability(Stable) @Nullable default GlueVersion getGlueVersion()
  
  Glue Version The version of Glue to use to execute this job.
  Default: - determined by the job type: 4.0 for ETL and Streaming, 5.0 for Flex, 3.0 for Python Shell
- getJobName
  
  @Stability(Stable) @Nullable default String getJobName()
  
  Name of the Glue job (optional) Developer-specified name of the Glue job.
  Default: - a name is automatically generated
- getMaxConcurrentRuns
  
  @Stability(Stable) @Nullable default Number getMaxConcurrentRuns()
  
  Max Concurrent Runs (optional) The maximum number of runs this Glue job can concurrently run.
  An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
  Default: 1
- getMaxRetries
  
  @Stability(Stable) @Nullable default Number getMaxRetries()
  
  Max Retries (optional) Maximum number of retry attempts Glue performs if the job fails.
  Default: 0
- getSecurityConfiguration
  
  @Stability(Stable) @Nullable default ISecurityConfiguration getSecurityConfiguration()
  
  Security Configuration (optional) Defines the encryption options for the Glue job.
  Default: - no security configuration.
- getTags
  
  @Stability(Stable) @Nullable default Map<String,String> getTags()
  
  Tags (optional) A list of key:value pairs of tags to apply to this Glue job resources.
  Default: {} - no tags
- getTimeout
  
  @Stability(Stable) @Nullable default Duration getTimeout()
  
  Timeout (optional) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
  Specified in minutes.
  Default: - no value set; Glue applies its service default (2880 minutes for non-streaming jobs)
- builder
  
  @Stability(Stable) static JobProps.Builder builder()
  
  Returns:
  
  a JobProps.Builder of JobProps

Interface JobProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getRole

getScript

getConnections

getContinuousLogging

getDefaultArguments

getDescription

getGlueVersion

getJobName

getMaxConcurrentRuns

getMaxRetries

getSecurityConfiguration

getTags

getTimeout

builder