software.amazon.awscdk.services.glue

Class Job

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.Resource

software.amazon.awscdk.services.glue.Job

All Implemented Interfaces:

IConstruct, IDependable, IResource, IJob, IGrantable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:23.311Z")
public class Job
extends Resource
implements IJob

(experimental) A Glue 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	Class and Description
static class	Job.Builder (experimental) A fluent builder for Job.

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.glue.IJob

IJob.Jsii$Default, IJob.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Job(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Job(software.amazon.jsii.JsiiObjectRef objRef)
	Job(software.constructs.Construct scope, java.lang.String id, JobProps props)

Method Summary

Modifier and Type	Method and Description
static IJob	fromJobAttributes(software.constructs.Construct scope, java.lang.String id, JobAttributes attrs) (experimental) Creates a Glue Job.
IPrincipal	getGrantPrincipal() (experimental) The principal this Glue Job is running as.
java.lang.String	getJobArn() (experimental) The ARN of the job.
java.lang.String	getJobName() (experimental) The name of the job.
IRole	getRole() (experimental) The IAM role Glue assumes to run this job.
SparkUILoggingLocation	getSparkUILoggingLocation() (experimental) The Spark UI logs location if Spark UI monitoring and debugging is enabled.
Metric	metric(java.lang.String metricName, MetricType type) (experimental) Create a CloudWatch metric.
Metric	metric(java.lang.String metricName, MetricType type, MetricOptions props) (experimental) Create a CloudWatch metric.
Metric	metricFailure() (experimental) Return a CloudWatch Metric indicating job failure.
Metric	metricFailure(MetricOptions props) (experimental) Return a CloudWatch Metric indicating job failure.
Metric	metricSuccess() (experimental) Return a CloudWatch Metric indicating job success.
Metric	metricSuccess(MetricOptions props) (experimental) Return a CloudWatch Metric indicating job success.
Metric	metricTimeout() (experimental) Return a CloudWatch Metric indicating job timeout.
Metric	metricTimeout(MetricOptions props) (experimental) Return a CloudWatch Metric indicating job timeout.
Rule	onEvent(java.lang.String id) (experimental) Create a CloudWatch Event Rule for this Glue Job when it's in a given state.
Rule	onEvent(java.lang.String id, OnEventOptions options) (experimental) Create a CloudWatch Event Rule for this Glue Job when it's in a given state.
Rule	onFailure(java.lang.String id) (experimental) Return a CloudWatch Event Rule matching FAILED state.
Rule	onFailure(java.lang.String id, OnEventOptions options) (experimental) Return a CloudWatch Event Rule matching FAILED state.
Rule	onStateChange(java.lang.String id, JobState jobState) (experimental) Create a CloudWatch Event Rule for the transition into the input jobState.
Rule	onStateChange(java.lang.String id, JobState jobState, OnEventOptions options) (experimental) Create a CloudWatch Event Rule for the transition into the input jobState.
Rule	onSuccess(java.lang.String id) (experimental) Create a CloudWatch Event Rule matching JobState.SUCCEEDED.
Rule	onSuccess(java.lang.String id, OnEventOptions options) (experimental) Create a CloudWatch Event Rule matching JobState.SUCCEEDED.
Rule	onTimeout(java.lang.String id) (experimental) Return a CloudWatch Event Rule matching TIMEOUT state.
Rule	onTimeout(java.lang.String id, OnEventOptions options) (experimental) Return a CloudWatch Event Rule matching TIMEOUT state.

Methods inherited from class software.amazon.awscdk.core.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isResource

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Constructor Detail

Job

protected Job(software.amazon.jsii.JsiiObjectRef objRef)

Job

protected Job(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Job

public Job(software.constructs.Construct scope,
           java.lang.String id,
           JobProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

Method Detail

fromJobAttributes

public static IJob fromJobAttributes(software.constructs.Construct scope,
                                     java.lang.String id,
                                     JobAttributes attrs)

(experimental) Creates a Glue Job.

Parameters:

scope - The scope creating construct (usually `this`). This parameter is required.

id - The construct's id. This parameter is required.

attrs - Import attributes. This parameter is required.

metric

public Metric metric(java.lang.String metricName,
                     MetricType type,
                     MetricOptions props)

(experimental) Create a CloudWatch metric.

Specified by:

metric in interface IJob

Parameters:

metricName - name of the metric typically prefixed with `glue.driver.`, `glue..` or `glue.ALL.`. This parameter is required.

type - the metric type. This parameter is required.

props - metric options.

See Also:

https://docs.aws.amazon.com/glue/latest/dg/monitoring-awsglue-with-cloudwatch-metrics.html

metric

public Metric metric(java.lang.String metricName,
                     MetricType type)

(experimental) Create a CloudWatch metric.

Specified by:

metric in interface IJob

Parameters:

metricName - name of the metric typically prefixed with `glue.driver.`, `glue..` or `glue.ALL.`. This parameter is required.

type - the metric type. This parameter is required.

See Also:

https://docs.aws.amazon.com/glue/latest/dg/monitoring-awsglue-with-cloudwatch-metrics.html

metricFailure

public Metric metricFailure(MetricOptions props)

(experimental) Return a CloudWatch Metric indicating job failure.

This metric is based on the Rule returned by no-args onFailure() call.

Specified by:

metricFailure in interface IJob

Parameters:

props -

metricFailure

public Metric metricFailure()

(experimental) Return a CloudWatch Metric indicating job failure.

This metric is based on the Rule returned by no-args onFailure() call.

Specified by:

metricFailure in interface IJob

metricSuccess

public Metric metricSuccess(MetricOptions props)

(experimental) Return a CloudWatch Metric indicating job success.

This metric is based on the Rule returned by no-args onSuccess() call.

Specified by:

metricSuccess in interface IJob

Parameters:

props -

metricSuccess

public Metric metricSuccess()

(experimental) Return a CloudWatch Metric indicating job success.

This metric is based on the Rule returned by no-args onSuccess() call.

Specified by:

metricSuccess in interface IJob

metricTimeout

public Metric metricTimeout(MetricOptions props)

(experimental) Return a CloudWatch Metric indicating job timeout.

This metric is based on the Rule returned by no-args onTimeout() call.

Specified by:

metricTimeout in interface IJob

Parameters:

props -

metricTimeout

public Metric metricTimeout()

(experimental) Return a CloudWatch Metric indicating job timeout.

This metric is based on the Rule returned by no-args onTimeout() call.

Specified by:

metricTimeout in interface IJob

onEvent

public Rule onEvent(java.lang.String id,
                    OnEventOptions options)

(experimental) Create a CloudWatch Event Rule for this Glue Job when it's in a given state.

Specified by:

onEvent in interface IJob

Parameters:

id - construct id. This parameter is required.

options - event options.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onEvent

public Rule onEvent(java.lang.String id)

(experimental) Create a CloudWatch Event Rule for this Glue Job when it's in a given state.

Specified by:

onEvent in interface IJob

Parameters:

id - construct id. This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onFailure

public Rule onFailure(java.lang.String id,
                      OnEventOptions options)

(experimental) Return a CloudWatch Event Rule matching FAILED state.

Specified by:

onFailure in interface IJob

Parameters:

id - construct id. This parameter is required.

options - optional event options.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onFailure

public Rule onFailure(java.lang.String id)

(experimental) Return a CloudWatch Event Rule matching FAILED state.

Specified by:

onFailure in interface IJob

Parameters:

id - construct id. This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onStateChange

public Rule onStateChange(java.lang.String id,
                          JobState jobState,
                          OnEventOptions options)

(experimental) Create a CloudWatch Event Rule for the transition into the input jobState.

Specified by:

onStateChange in interface IJob

Parameters:

id - construct id. This parameter is required.

jobState - the job state. This parameter is required.

options - optional event options.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onStateChange

public Rule onStateChange(java.lang.String id,
                          JobState jobState)

(experimental) Create a CloudWatch Event Rule for the transition into the input jobState.

Specified by:

onStateChange in interface IJob

Parameters:

id - construct id. This parameter is required.

jobState - the job state. This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onSuccess

public Rule onSuccess(java.lang.String id,
                      OnEventOptions options)

(experimental) Create a CloudWatch Event Rule matching JobState.SUCCEEDED.

Specified by:

onSuccess in interface IJob

Parameters:

id - construct id. This parameter is required.

options - optional event options.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onSuccess

public Rule onSuccess(java.lang.String id)

(experimental) Create a CloudWatch Event Rule matching JobState.SUCCEEDED.

Specified by:

onSuccess in interface IJob

Parameters:

id - construct id. This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onTimeout

public Rule onTimeout(java.lang.String id,
                      OnEventOptions options)

(experimental) Return a CloudWatch Event Rule matching TIMEOUT state.

Specified by:

onTimeout in interface IJob

Parameters:

id - construct id. This parameter is required.

options - optional event options.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onTimeout

public Rule onTimeout(java.lang.String id)

(experimental) Return a CloudWatch Event Rule matching TIMEOUT state.

Specified by:

onTimeout in interface IJob

Parameters:

id - construct id. This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

getGrantPrincipal

public IPrincipal getGrantPrincipal()

(experimental) The principal this Glue Job is running as.

Specified by:

getGrantPrincipal in interface IGrantable

getJobArn

public java.lang.String getJobArn()

(experimental) The ARN of the job.

Specified by:

getJobArn in interface IJob

getJobName

public java.lang.String getJobName()

(experimental) The name of the job.

Specified by:

getJobName in interface IJob

getRole

public IRole getRole()

(experimental) The IAM role Glue assumes to run this job.

getSparkUILoggingLocation

public SparkUILoggingLocation getSparkUILoggingLocation()

(experimental) The Spark UI logs location if Spark UI monitoring and debugging is enabled.

See Also:

https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html