CfnJobProps (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnJobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.557Z")
 @Stability(value=Stable)
public interface CfnJobProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `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 tags;
 CfnJobProps cfnJobProps = CfnJobProps.builder()
         .command(JobCommandProperty.builder()
                 .name("name")
                 .pythonVersion("pythonVersion")
                 .scriptLocation("scriptLocation")
                 .build())
         .role("role")
         // the properties below are optional
         .allocatedCapacity(123)
         .connections(ConnectionsListProperty.builder()
                 .connections(List.of("connections"))
                 .build())
         .defaultArguments(defaultArguments)
         .description("description")
         .executionProperty(ExecutionPropertyProperty.builder()
                 .maxConcurrentRuns(123)
                 .build())
         .glueVersion("glueVersion")
         .logUri("logUri")
         .maxCapacity(123)
         .maxRetries(123)
         .name("name")
         .notificationProperty(NotificationPropertyProperty.builder()
                 .notifyDelayAfter(123)
                 .build())
         .numberOfWorkers(123)
         .securityConfiguration("securityConfiguration")
         .tags(tags)
         .timeout(123)
         .workerType("workerType")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`CfnJobProps.Builder` A builder for `CfnJobProps`
`static class`	`CfnJobProps.Jsii$Proxy` An implementation for `CfnJobProps`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static CfnJobProps.Builder`	`builder()`
`default Number`	`getAllocatedCapacity()` The number of capacity units that are allocated to this job.
`Object`	`getCommand()` The code that executes a job.
`default Object`	`getConnections()` The connections used for this job.
`default Object`	`getDefaultArguments()` The default arguments for this job, specified as name-value pairs.
`default String`	`getDescription()` A description of the job.
`default Object`	`getExecutionProperty()` The maximum number of concurrent runs that are allowed for this job.
`default String`	`getGlueVersion()` Glue version determines the versions of Apache Spark and Python that AWS Glue supports.
`default String`	`getLogUri()` This field is reserved for future use.
`default Number`	`getMaxCapacity()` The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
`default Number`	`getMaxRetries()` 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`	`getNotificationProperty()` Specifies configuration properties of a notification.
`default Number`	`getNumberOfWorkers()` The number of workers of a defined `workerType` that are allocated when a job runs.
`String`	`getRole()` The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
`default String`	`getSecurityConfiguration()` The name of the `SecurityConfiguration` structure to be used with this job.
`default Object`	`getTags()` The tags to use with this job.
`default Number`	`getTimeout()` The job timeout in minutes.
`default String`	`getWorkerType()` The type of predefined worker that is allocated when a job runs.

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

- Method Detail
  - getCommand
```
@Stability(value=Stable)
 @NotNull
Object getCommand()
```
    The code that executes a job.
  - getRole
```
@Stability(value=Stable)
 @NotNull
String getRole()
```
    The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
  - getAllocatedCapacity
```
@Stability(value=Stable)
 @Nullable
default Number getAllocatedCapacity()
```
    The number of capacity units that are allocated to this job.
  - getConnections
```
@Stability(value=Stable)
 @Nullable
default Object getConnections()
```
    The connections used for this job.
  - getDefaultArguments
```
@Stability(value=Stable)
 @Nullable
default Object 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
```
@Stability(value=Stable)
 @Nullable
default String getDescription()
```
    A description of the job.
  - getExecutionProperty
```
@Stability(value=Stable)
 @Nullable
default Object getExecutionProperty()
```
    The maximum number of concurrent runs that are allowed for this job.
  - getGlueVersion
```
@Stability(value=Stable)
 @Nullable
default String 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
```
@Stability(value=Stable)
 @Nullable
default String getLogUri()
```
    This field is reserved for future use.
  - getMaxCapacity
```
@Stability(value=Stable)
 @Nullable
default Number 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 using WorkerType and NumberOfWorkers .
    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.
  - getMaxRetries
```
@Stability(value=Stable)
 @Nullable
default Number getMaxRetries()
```
    The maximum number of times to retry this job after a JobRun fails.
  - getName
```
@Stability(value=Stable)
 @Nullable
default String getName()
```
    The name you assign to this job definition.
  - getNotificationProperty
```
@Stability(value=Stable)
 @Nullable
default Object getNotificationProperty()
```
    Specifies configuration properties of a notification.
  - getNumberOfWorkers
```
@Stability(value=Stable)
 @Nullable
default Number getNumberOfWorkers()
```
    The number of workers of a defined `workerType` that are allocated when a job runs.
    The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .
  - getSecurityConfiguration
```
@Stability(value=Stable)
 @Nullable
default String getSecurityConfiguration()
```
    The name of the `SecurityConfiguration` structure to be used with this job.
  - getTags
```
@Stability(value=Stable)
 @Nullable
default Object getTags()
```
    The tags to use with this job.
  - getTimeout
```
@Stability(value=Stable)
 @Nullable
default Number 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
```
@Stability(value=Stable)
 @Nullable
default String 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.
  - builder
```
@Stability(value=Stable)
static CfnJobProps.Builder builder()
```
    Returns:
    
    a CfnJobProps.Builder of CfnJobProps

Interface CfnJobProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getCommand

getRole

getAllocatedCapacity

getConnections

getDefaultArguments

getDescription

getExecutionProperty

getGlueVersion

getLogUri

getMaxCapacity

getMaxRetries

getName

getNotificationProperty

getNumberOfWorkers

getSecurityConfiguration

getTags

getTimeout

getWorkerType

builder