JobProps

All Known Implementing Classes:: JobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:35.180Z")
public interface JobProps

(experimental) Construction properties for Job.

Example:

 Bucket bucket;
 Job.Builder.create(this, "PythonShellJob")
         .executable(JobExecutable.pythonShell(PythonShellExecutableProps.builder()
                 .glueVersion(GlueVersion.V1_0)
                 .pythonVersion(PythonVersion.THREE)
                 .script(Code.fromBucket(bucket, "script.py"))
                 .build()))
         .description("an example Python Shell job")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class JobProps.Builder
A builder for JobProps

static class JobProps.Jsii$Proxy
An implementation for JobProps

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static JobProps.Builder`	`builder()`
`default java.util.List<IConnection>`	`getConnections()` (experimental) The `Connection`s used for this job.
`default ContinuousLoggingProps`	`getContinuousLogging()` (experimental) Enables continuous logging with the specified props.
`default java.util.Map<java.lang.String,java.lang.String>`	`getDefaultArguments()` (experimental) The default arguments for this job, specified as name-value pairs.
`default java.lang.String`	`getDescription()` (experimental) The description of the job.
`default java.lang.Boolean`	`getEnableProfilingMetrics()` (experimental) Enables the collection of metrics for job profiling.
`JobExecutable`	`getExecutable()` (experimental) The job's executable properties.
`default java.lang.String`	`getJobName()` (experimental) The name of the job.
`default java.lang.Number`	`getMaxCapacity()` (experimental) The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
`default java.lang.Number`	`getMaxConcurrentRuns()` (experimental) The maximum number of concurrent runs allowed for the job.
`default java.lang.Number`	`getMaxRetries()` (experimental) The maximum number of times to retry this job after a job run fails.
`default Duration`	`getNotifyDelayAfter()` (experimental) The number of minutes to wait after a job run starts, before sending a job run delay notification.
`default IRole`	`getRole()` (experimental) The IAM role assumed by Glue to run this job.
`default ISecurityConfiguration`	`getSecurityConfiguration()` (experimental) The `SecurityConfiguration` to use for this job.
`default SparkUIProps`	`getSparkUI()` (experimental) Enables the Spark UI debugging and monitoring with the specified props.
`default java.util.Map<java.lang.String,java.lang.String>`	`getTags()` (experimental) The tags to add to the resources on which the job runs.
`default Duration`	`getTimeout()` (experimental) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
`default java.lang.Number`	`getWorkerCount()` (experimental) The number of workers of a defined `WorkerType` that are allocated when a job runs.
`default WorkerType`	`getWorkerType()` (experimental) The type of predefined worker that is allocated when a job runs.

- Method Detail
  - getExecutable
```
JobExecutable getExecutable()
```
    (experimental) The job's executable properties.
  - getConnections
```
default java.util.List<IConnection> getConnections()
```
    (experimental) The Connections used for this job.
    Connections are used to connect to other AWS Service or resources within a VPC.
    Default: [] - no connections are added to the job
  - getContinuousLogging
```
default ContinuousLoggingProps getContinuousLogging()
```
    (experimental) Enables continuous logging with the specified props.
    Default: - continuous logging is disabled.
    
    See Also:
    
    https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
  - getDefaultArguments
```
default java.util.Map<java.lang.String,java.lang.String> getDefaultArguments()
```
    (experimental) The default arguments for this job, specified as name-value pairs.
    Default: - no arguments
    
    See Also:
    
    for a list of reserved parameters
  - getDescription
```
default java.lang.String getDescription()
```
    (experimental) The description of the job.
    Default: - no value
  - getEnableProfilingMetrics
```
default java.lang.Boolean getEnableProfilingMetrics()
```
    (experimental) Enables the collection of metrics for job profiling.
    Default: - no profiling metrics emitted.
    
    See Also:
    
    at https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
  - getJobName
```
default java.lang.String getJobName()
```
    (experimental) The name of the job.
    Default: - a name is automatically generated
  - getMaxCapacity
```
default java.lang.Number getMaxCapacity()
```
    (experimental) 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.
    Default: - 10 when job type is Apache Spark ETL or streaming, 0.0625 when job type is Python shell
  - getMaxConcurrentRuns
```
default java.lang.Number getMaxConcurrentRuns()
```
    (experimental) 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.
    Default: 1
  - getMaxRetries
```
default java.lang.Number getMaxRetries()
```
    (experimental) The maximum number of times to retry this job after a job run fails.
    Default: 0
  - getNotifyDelayAfter
```
default Duration getNotifyDelayAfter()
```
    (experimental) The number of minutes to wait after a job run starts, before sending a job run delay notification.
    Default: - no delay notifications
  - getRole
```
default IRole getRole()
```
    (experimental) 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.
    Default: - a role is automatically generated
    
    See Also:
    
    https://docs.aws.amazon.com/glue/latest/dg/getting-started-access.html
  - getSecurityConfiguration
```
default ISecurityConfiguration getSecurityConfiguration()
```
    (experimental) The SecurityConfiguration to use for this job.
    Default: - no security configuration.
  - getSparkUI
```
default SparkUIProps getSparkUI()
```
    (experimental) Enables the Spark UI debugging and monitoring with the specified props.
    Default: - Spark UI debugging and monitoring is disabled.
    
    See Also:
    
    https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
  - getTags
```
default java.util.Map<java.lang.String,java.lang.String> getTags()
```
    (experimental) The tags to add to the resources on which the job runs.
    Default: {} - no tags
  - getTimeout
```
default Duration getTimeout()
```
    (experimental) The maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status.
    Default: cdk.Duration.hours(48)
  - getWorkerCount
```
default java.lang.Number getWorkerCount()
```
    (experimental) The number of workers of a defined WorkerType that are allocated when a job runs.
    Default: - differs based on specific Glue version/worker type
  - getWorkerType
```
default WorkerType getWorkerType()
```
    (experimental) The type of predefined worker that is allocated when a job runs.
    Default: - differs based on specific Glue version
  - builder
```
static JobProps.Builder builder()
```
    Returns:
    
    a JobProps.Builder of JobProps

Interface JobProps

Nested Class Summary

Method Summary

Method Detail

getExecutable

getConnections

getContinuousLogging

getDefaultArguments

getDescription

getEnableProfilingMetrics

getJobName

getMaxCapacity

getMaxConcurrentRuns

getMaxRetries

getNotifyDelayAfter

getRole

getSecurityConfiguration

getSparkUI

getTags

getTimeout

getWorkerCount

getWorkerType

builder