interface IJob ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.Glue.Alpha.IJob
Go	github.com/aws/aws-cdk-go/awscdkgluealpha/v2#IJob
Java	software.amazon.awscdk.services.glue.alpha.IJob
Python	aws_cdk.aws_glue_alpha.IJob
TypeScript (source)	@aws-cdk/aws-glue-alpha » IJob

⚠️ Deprecated: undefined

Implements IDependable, IConstruct, IEnvironmentAware, IResource, IGrantable, IJobRef

Implemented by PySparkEtlJob, PySparkFlexEtlJob, PySparkStreamingJob, PythonShellJob, RayJob, ScalaSparkEtlJob, ScalaSparkFlexEtlJob, ScalaSparkStreamingJob

Obtainable from Job.fromJobAttributes()

Interface representing a new or an imported Glue Job.

Properties

Name	Type	Description
env⚠️	ResourceEnvironment	The environment this resource belongs to.
grantPrincipal⚠️	IPrincipal	The principal to grant permissions to.
jobArn⚠️	string	The ARN of the job.
jobName⚠️	string	The name of the job.
jobRef⚠️	JobReference	A reference to a Job resource.
node⚠️	Node	The tree node.
stack⚠️	Stack	The stack in which this resource is defined.

---

env⚠️

⚠️ Deprecated: undefined

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

grantPrincipal⚠️

⚠️ Deprecated: undefined

Type: IPrincipal

The principal to grant permissions to.

---

jobArn⚠️

⚠️ Deprecated: undefined

Type: string

The ARN of the job.

---

jobName⚠️

⚠️ Deprecated: undefined

Type: string

The name of the job.

---

jobRef⚠️

⚠️ Deprecated: undefined

Type: JobReference

A reference to a Job resource.

---

node⚠️

⚠️ Deprecated: undefined

Type: Node

The tree node.

---

stack⚠️

⚠️ Deprecated: undefined

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)⚠️	Apply the given removal policy to this resource.
metric(metricName, type, props?)⚠️	Create a CloudWatch metric.
metricFailure(props?)⚠️	Create a CloudWatch Metric indicating job failure.
metricSuccess(props?)⚠️	Create a CloudWatch Metric indicating job success.
metricTimeout(props?)⚠️	Create a CloudWatch Metric indicating job timeout.
onEvent(id, options?)⚠️	Defines a CloudWatch event rule triggered when something happens with this job.
onFailure(id, options?)⚠️	Defines a CloudWatch event rule triggered when this job moves to the FAILED state.
onSuccess(id, options?)⚠️	Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
onTimeout(id, options?)⚠️	Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.
with(...mixins)⚠️	Applies one or more mixins to this construct.

---

applyRemovalPolicy(policy)⚠️

public applyRemovalPolicy(policy: RemovalPolicy): void

⚠️ Deprecated: undefined

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

metric(metricName, type, props?)⚠️

public metric(metricName: string, type: MetricType, props?: MetricOptions): Metric

⚠️ Deprecated: undefined

Parameters

• metricName string — name of the metric typically prefixed with glue.driver., glue.<executorId>. or glue.ALL..
• type MetricType — the metric type.
• props MetricOptions — metric options.

Returns

• Metric

Create a CloudWatch metric.

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

---

metricFailure(props?)⚠️

public metricFailure(props?: MetricOptions): Metric

⚠️ Deprecated: undefined

Parameters

• props MetricOptions

Returns

• Metric

Create a CloudWatch Metric indicating job failure.

---

metricSuccess(props?)⚠️

public metricSuccess(props?: MetricOptions): Metric

⚠️ Deprecated: undefined

Parameters

• props MetricOptions

Returns

• Metric

Create a CloudWatch Metric indicating job success.

---

metricTimeout(props?)⚠️

public metricTimeout(props?: MetricOptions): Metric

⚠️ Deprecated: undefined

Parameters

• props MetricOptions

Returns

• Metric

Create a CloudWatch Metric indicating job timeout.

---

onEvent(id, options?)⚠️

public onEvent(id: string, options?: OnEventOptions): Rule

⚠️ Deprecated: undefined

Parameters

• id string
• options OnEventOptions

Returns

• Rule

Defines a CloudWatch event rule triggered when something happens with this job.

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

---

onFailure(id, options?)⚠️

public onFailure(id: string, options?: OnEventOptions): Rule

⚠️ Deprecated: undefined

Parameters

• id string
• options OnEventOptions

Returns

• Rule

Defines a CloudWatch event rule triggered when this job moves to the FAILED state.

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

---

onSuccess(id, options?)⚠️

public onSuccess(id: string, options?: OnEventOptions): Rule

⚠️ Deprecated: undefined

Parameters

• id string
• options OnEventOptions

Returns

• Rule

Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.

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

---

onTimeout(id, options?)⚠️

public onTimeout(id: string, options?: OnEventOptions): Rule

⚠️ Deprecated: undefined

Parameters

• id string
• options OnEventOptions

Returns

• Rule

Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

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

---

with(...mixins)⚠️

public with(...mixins: IMixin[]): IConstruct

⚠️ Deprecated: undefined

Parameters

• mixins IMixin — The mixins to apply.

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.