Interface CfnJobProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnJobProps.Jsii$Proxy
CfnJob
.
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.*; Object defaultArguments; Object nonOverridableArguments; Object tags; CfnJobProps cfnJobProps = CfnJobProps.builder() .command(JobCommandProperty.builder() .name("name") .pythonVersion("pythonVersion") .runtime("runtime") .scriptLocation("scriptLocation") .build()) .role("role") // the properties below are optional .allocatedCapacity(123) .connections(ConnectionsListProperty.builder() .connections(List.of("connections")) .build()) .defaultArguments(defaultArguments) .description("description") .executionClass("executionClass") .executionProperty(ExecutionPropertyProperty.builder() .maxConcurrentRuns(123) .build()) .glueVersion("glueVersion") .jobMode("jobMode") .jobRunQueuingEnabled(false) .logUri("logUri") .maintenanceWindow("maintenanceWindow") .maxCapacity(123) .maxRetries(123) .name("name") .nonOverridableArguments(nonOverridableArguments) .notificationProperty(NotificationPropertyProperty.builder() .notifyDelayAfter(123) .build()) .numberOfWorkers(123) .securityConfiguration("securityConfiguration") .tags(tags) .timeout(123) .workerType("workerType") .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnJobProps
static final class
An implementation forCfnJobProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnJobProps.Builder
builder()
default Number
This parameter is no longer supported.The code that executes a job.default Object
The connections used for this job.default Object
The default arguments for this job, specified as name-value pairs.default String
A description of the job.default String
Indicates whether the job is run with a standard or flexible execution class.default Object
The maximum number of concurrent runs that are allowed for this job.default String
Glue version determines the versions of Apache Spark and Python that AWS Glue supports.default String
A mode that describes how a job was created.default Object
Specifies whether job run queuing is enabled for the job runs for this job.default String
This field is reserved for future use.default String
This field specifies a day of the week and hour for a maintenance window for streaming jobs.default Number
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.default Number
The maximum number of times to retry this job after a JobRun fails.default String
getName()
The name you assign to this job definition.default Object
Non-overridable arguments for this job, specified as name-value pairs.default Object
Specifies configuration properties of a notification.default Number
The number of workers of a definedworkerType
that are allocated when a job runs.getRole()
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.default String
The name of theSecurityConfiguration
structure to be used with this job.default Object
getTags()
The tags to use with this job.default Number
The job timeout in minutes.default String
The type of predefined worker that is allocated when a job runs.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCommand
The code that executes a job.- See Also:
-
getRole
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.- See Also:
-
getAllocatedCapacity
This parameter is no longer supported. UseMaxCapacity
instead.The number of capacity units that are allocated to this job.
- See Also:
-
getConnections
The connections used for this job.- See Also:
-
getDefaultArguments
The default arguments for this job, specified as name-value pairs.You can specify arguments here that your own job-execution script consumes, in addition to arguments that AWS Glue itself consumes.
For information about how to specify and consume your own job arguments, see Calling AWS Glue APIs in Python in the AWS Glue Developer Guide .
For information about the key-value pairs that AWS Glue consumes to set up your job, see Special Parameters Used by AWS Glue in the AWS Glue Developer Guide .
- See Also:
-
getDescription
A description of the job.- See Also:
-
getExecutionClass
Indicates whether the job is run with a standard or flexible execution class.The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with AWS Glue version 3.0 and above and command type
glueetl
will be allowed to setExecutionClass
toFLEX
. The flexible execution class is available for Spark jobs.- See Also:
-
getExecutionProperty
The maximum number of concurrent runs that are allowed for this job.- See Also:
-
getGlueVersion
Glue version determines the versions of Apache Spark and Python that AWS Glue supports.The Python version indicates the version supported for jobs of type Spark.
For more information about the available AWS Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to the latest Glue version available.
- See Also:
-
getJobMode
A mode that describes how a job was created. Valid values are:.SCRIPT
- The job was created using the AWS Glue Studio script editor.VISUAL
- The job was created using the AWS Glue Studio visual editor.NOTEBOOK
- The job was created using an interactive sessions notebook.
When the
JobMode
field is missing or null,SCRIPT
is assigned as the default value.- See Also:
-
getJobRunQueuingEnabled
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.
- See Also:
-
getLogUri
This field is reserved for future use.- See Also:
-
getMaintenanceWindow
This field specifies a day of the week and hour for a maintenance window for streaming jobs.AWS Glue periodically performs maintenance activities. During these maintenance windows, AWS Glue will need to restart your streaming jobs.
AWS Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
- See Also:
-
getMaxCapacity
The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.
Do not set
Max Capacity
if usingWorkerType
andNumberOfWorkers
.The value that can be allocated for
MaxCapacity
depends on whether you are running a Python shell job or an Apache Spark ETL job:- When you specify a Python shell job (
JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. - When you specify an Apache Spark ETL job (
JobCommand.Name
="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
- See Also:
- When you specify a Python shell job (
-
getMaxRetries
The maximum number of times to retry this job after a JobRun fails.- See Also:
-
getName
The name you assign to this job definition.- See Also:
-
getNonOverridableArguments
Non-overridable arguments for this job, specified as name-value pairs.- See Also:
-
getNotificationProperty
Specifies configuration properties of a notification.- See Also:
-
getNumberOfWorkers
The number of workers of a definedworkerType
that are allocated when a job runs.The maximum number of workers you can define are 299 for
G.1X
, and 149 forG.2X
.- See Also:
-
getSecurityConfiguration
The name of theSecurityConfiguration
structure to be used with this job.- See Also:
-
getTags
The tags to use with this job.- See Also:
-
getTimeout
The job timeout in minutes.This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).
- See Also:
-
getWorkerType
The type of predefined worker that is allocated when a job runs.Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
- For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 94GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. - For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 138GB disk, and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs. - For the
G.4X
worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs in the following AWS Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm). - For the
G.8X
worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk, and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for AWS Glue version 3.0 or later Spark ETL jobs, in the same AWS Regions as supported for theG.4X
worker type. - For the
G.025X
worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk, and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for AWS Glue version 3.0 or later streaming jobs. - For the
Z.2X
worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk, and provides up to 8 Ray workers based on the autoscaler.
- See Also:
- For the
-
builder
- Returns:
- a
CfnJobProps.Builder
ofCfnJobProps
-