JobProps (software.amazon.awscdk:monocdk 1.180.0.DEVPREVIEW API)

All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: JobProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.70.0 (build 03c2f6f)",
           date="2022-11-01T13:16:49.658Z")
 @Stability(value=Experimental)
public interface JobProps
extends software.amazon.jsii.JsiiSerializable

(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 List<IConnection>`	`getConnections()` (experimental) The `Connection`s used for this job.
`default ContinuousLoggingProps`	`getContinuousLogging()` (experimental) Enables continuous logging with the specified props.
`default Map<String,String>`	`getDefaultArguments()` (experimental) The default arguments for this job, specified as name-value pairs.
`default String`	`getDescription()` (experimental) The description of the job.
`default Boolean`	`getEnableProfilingMetrics()` (experimental) Enables the collection of metrics for job profiling.
`JobExecutable`	`getExecutable()` (experimental) The job's executable properties.
`default String`	`getJobName()` (experimental) The name of the job.
`default Number`	`getMaxCapacity()` (experimental) The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.
`default Number`	`getMaxConcurrentRuns()` (experimental) The maximum number of concurrent runs allowed for the job.
`default 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 Map<String,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 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.

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

- Method Detail
  - getExecutable
```
@Stability(value=Experimental)
 @NotNull
JobExecutable getExecutable()
```
    (experimental) The job's executable properties.
  - getConnections
```
@Stability(value=Experimental)
 @Nullable
default 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
```
@Stability(value=Experimental)
 @Nullable
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
```
@Stability(value=Experimental)
 @Nullable
default Map<String,String> getDefaultArguments()
```
    (experimental) The default arguments for this job, specified as name-value pairs.
    Default: - no arguments
    
    See Also:
    
    https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html for a list of reserved parameters
  - getDescription
```
@Stability(value=Experimental)
 @Nullable
default String getDescription()
```
    (experimental) The description of the job.
    Default: - no value
  - getEnableProfilingMetrics
```
@Stability(value=Experimental)
 @Nullable
default Boolean getEnableProfilingMetrics()
```
    (experimental) Enables the collection of metrics for job profiling.
    Default: - no profiling metrics emitted.
    
    See Also:
    
    `--enable-metrics` at https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html
  - getJobName
```
@Stability(value=Experimental)
 @Nullable
default String getJobName()
```
    (experimental) The name of the job.
    Default: - a name is automatically generated
  - getMaxCapacity
```
@Stability(value=Experimental)
 @Nullable
default 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
```
@Stability(value=Experimental)
 @Nullable
default 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
```
@Stability(value=Experimental)
 @Nullable
default Number getMaxRetries()
```
    (experimental) The maximum number of times to retry this job after a job run fails.
    Default: 0
  - getNotifyDelayAfter
```
@Stability(value=Experimental)
 @Nullable
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
```
@Stability(value=Experimental)
 @Nullable
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
```
@Stability(value=Experimental)
 @Nullable
default ISecurityConfiguration getSecurityConfiguration()
```
    (experimental) The SecurityConfiguration to use for this job.
    Default: - no security configuration.
  - getSparkUI
```
@Stability(value=Experimental)
 @Nullable
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
```
@Stability(value=Experimental)
 @Nullable
default Map<String,String> getTags()
```
    (experimental) The tags to add to the resources on which the job runs.
    Default: {} - no tags
  - getTimeout
```
@Stability(value=Experimental)
 @Nullable
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
```
@Stability(value=Experimental)
 @Nullable
default 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
```
@Stability(value=Experimental)
 @Nullable
default WorkerType getWorkerType()
```
    (experimental) The type of predefined worker that is allocated when a job runs.
    Default: - differs based on specific Glue version
  - builder
```
@Stability(value=Experimental)
static JobProps.Builder builder()
```
    Returns:
    
    a JobProps.Builder of JobProps

Interface JobProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getExecutable

getConnections

getContinuousLogging

getDefaultArguments

getDescription

getEnableProfilingMetrics

getJobName

getMaxCapacity

getMaxConcurrentRuns

getMaxRetries

getNotifyDelayAfter

getRole

getSecurityConfiguration

getSparkUI

getTags

getTimeout

getWorkerCount

getWorkerType

builder