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") .logUri("logUri") .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();
-
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
This field is reserved for future use.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. -
getRole
The name or Amazon Resource Name (ARN) of the IAM role associated with this job. -
getAllocatedCapacity
This parameter is no longer supported. UseMaxCapacity
instead.The number of capacity units that are allocated to this job.
-
getConnections
The connections used for this job. -
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 .
-
getDescription
A description of the job. -
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. -
getExecutionProperty
The maximum number of concurrent runs that are allowed for this job. -
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 Glue 0.9.
-
getLogUri
This field is reserved for future use. -
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.
- When you specify a Python shell job (
-
getMaxRetries
The maximum number of times to retry this job after a JobRun fails. -
getName
The name you assign to this job definition. -
getNonOverridableArguments
Non-overridable arguments for this job, specified as name-value pairs. -
getNotificationProperty
Specifies configuration properties of a notification. -
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
. -
getSecurityConfiguration
The name of theSecurityConfiguration
structure to be used with this job. -
getTags
The tags to use with this job. -
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).
-
getWorkerType
The type of predefined worker that is allocated when a job runs.Accepts a value of Standard, G.1X, or G.2X.
- For the
Standard
worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker. - For the
G.1X
worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs. - For the
G.2X
worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
- For the
-
builder
- Returns:
- a
CfnJobProps.Builder
ofCfnJobProps
-