interface IJob 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Glue.IJob
Java	software.amazon.awscdk.services.glue.IJob
Python	aws_cdk.aws_glue.IJob
TypeScript (source)	@aws-cdk/aws-glue » IJob

Implemented by Job

Obtainable from Job.fromJobAttributes()

Interface representing a created or an imported {@link 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.
node🔹	ConstructNode	The construct tree node for this construct.
stack🔹	Stack	The stack in which this resource is defined.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

---

jobArn🔹

Type: string

The ARN of the job.

---

jobName🔹

Type: string

The name of the job.

---

node🔹

Type: ConstructNode

The construct tree node for this construct.

---

stack🔹

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.
onStateChange(id, jobState, options?)🔹	Defines a CloudWatch event rule triggered when this job moves to the input jobState.
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.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

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

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

Parameters

• props MetricOptions

Returns

• Metric

Create a CloudWatch Metric indicating job failure.

---

metricSuccess(props?)🔹

public metricSuccess(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Create a CloudWatch Metric indicating job success.

---

metricTimeout(props?)🔹

public metricTimeout(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Create a CloudWatch Metric indicating job timeout.

---

onEvent(id, options?)🔹

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

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

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

---

onStateChange(id, jobState, options?)🔹

public onStateChange(id: string, jobState: JobState, options?: OnEventOptions): Rule

Parameters

• id string
• jobState JobState
• options OnEventOptions

Returns

• Rule

Defines a CloudWatch event rule triggered when this job moves to the input jobState.

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

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

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