interface JobProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Glue.Alpha.JobProps |
 Go | github.com/aws/aws-cdk-go/awscdkgluealpha/v2#JobProps |
 Java | software.amazon.awscdk.services.glue.alpha.JobProps |
 Python | aws_cdk.aws_glue_alpha.JobProps |
 TypeScript (source) | @aws-cdk/aws-glue-alpha » JobProps |
Construction properties for Job.
Example
new glue.Job(this, 'EnableRunQueuing', {
jobName: 'EtlJobWithRunQueuing',
executable: glue.JobExecutable.pythonEtl({
glueVersion: glue.GlueVersion.V4_0,
pythonVersion: glue.PythonVersion.THREE,
script: glue.Code.fromAsset(path.join(__dirname, 'job-script', 'hello_world.py')),
}),
jobRunQueuingEnabled: true,
});
Properties
| Name | Type | Description |
|---|---|---|
| executable | Job | The job's executable properties. |
| connections? | IConnection[] | The Connections used for this job. |
| continuous | Continuous | Enables continuous logging with the specified props. |
| default | { [string]: string } | The default arguments for this job, specified as name-value pairs. |
| description? | string | The description of the job. |
| enable | boolean | Enables the collection of metrics for job profiling. |
| execution | Execution | The ExecutionClass whether the job is run with a standard or flexible execution class. |
| job | string | The name of the job. |
| job | boolean | Specifies whether job run queuing is enabled for the job runs for this job. |
| max | number | The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs. |
| max | number | The maximum number of concurrent runs allowed for the job. |
| max | number | The maximum number of times to retry this job after a job run fails. |
| notify | Duration | The number of minutes to wait after a job run starts, before sending a job run delay notification. |
| role? | IRole | The IAM role assumed by Glue to run this job. |
| security | ISecurity | The SecurityConfiguration to use for this job. |
| spark | Spark | Enables the Spark UI debugging and monitoring with the specified props. |
| tags? | { [string]: string } | The tags to add to the resources on which the job runs. |
| timeout? | Duration | The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. |
| worker | number | The number of workers of a defined WorkerType that are allocated when a job runs. |
| worker | Worker | The type of predefined worker that is allocated when a job runs. |
executable
Type:
Job
The job's executable properties.
connections?
Type:
IConnection[]
(optional, default: [] - no connections are added to the job)
The Connections used for this job.
Connections are used to connect to other AWS Service or resources within a VPC.
continuousLogging?
Type:
Continuous
(optional, default: continuous logging is disabled.)
Enables continuous logging with the specified props.
defaultArguments?
Type:
{ [string]: string }
(optional, default: no arguments)
The default arguments for this job, specified as name-value pairs.
description?
Type:
string
(optional, default: no value)
The description of the job.
enableProfilingMetrics?
Type:
boolean
(optional, default: no profiling metrics emitted.)
Enables the collection of metrics for job profiling.
Equivalent to a job parameter --enable-metrics.
executionClass?
Type:
Execution
(optional, default: STANDARD)
The ExecutionClass whether the job is run with a standard or flexible execution class.
See also: https://docs.aws.amazon.com/glue/latest/dg/add-job.html
jobName?
Type:
string
(optional, default: a name is automatically generated)
The name of the job.
jobRunQueuingEnabled?
Type:
boolean
(optional, default: no job run queuing)
Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing. If this field does not match the value set in the job run, then the value from the job run field will be used.
maxCapacity?
Type:
number
(optional, default: 10 when job type is Apache Spark ETL or streaming, 0.0625 when job type is Python shell)
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
Cannot be used for Glue version 2.0 and later - workerType and workerCount should be used instead.
maxConcurrentRuns?
Type:
number
(optional, default: 1)
The maximum number of concurrent runs allowed for the job.
An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
maxRetries?
Type:
number
(optional, default: 0)
The maximum number of times to retry this job after a job run fails.
notifyDelayAfter?
Type:
Duration
(optional, default: no delay notifications)
The number of minutes to wait after a job run starts, before sending a job run delay notification.
role?
Type:
IRole
(optional, default: a role is automatically generated)
The IAM role assumed by Glue to run this job.
If providing a custom role, it needs to 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
securityConfiguration?
Type:
ISecurity
(optional, default: no security configuration.)
The SecurityConfiguration to use for this job.
sparkUI?
Type:
Spark
(optional, default: Spark UI debugging and monitoring is disabled.)
Enables the Spark UI debugging and monitoring with the specified props.
tags?
Type:
{ [string]: string }
(optional, default: {} - no tags)
The tags to add to the resources on which the job runs.
timeout?
Type:
Duration
(optional, default: cdk.Duration.hours(48))
The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
workerCount?
Type:
number
(optional, default: differs based on specific Glue version/worker type)
The number of workers of a defined WorkerType that are allocated when a job runs.
workerType?
Type:
Worker
(optional, default: differs based on specific Glue version)
The type of predefined worker that is allocated when a job runs.