class JobBase 🔹

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

Implements IConstruct, IDependable, IResource, IJob, IGrantable

Extends Resource

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

A base class is needed to be able to import existing Jobs into a CDK app to reference as part of a larger stack or construct.

JobBase has the subset of attribtues required to idenitfy and reference an existing Glue Job, as well as some CloudWatch metric conveneince functions to configure an event-driven flow using the job.

Initializer

new JobBase(scope: Construct, id: string, props?: ResourceProps)

Parameters

• scope Construct
• id string
• props ResourceProps

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🔹	Node	The tree node.
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: Node

The tree node.

---

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?)🔹	Return a CloudWatch Metric indicating job failure.
metricSuccess(props?)🔹	Return a CloudWatch Metric indicating job success.
metricTimeout(props?)🔹	Return a CloudWatch Metric indicating job timeout.
onEvent(id, options?)🔹	Create a CloudWatch Event Rule for this Glue Job when it's in a given state.
onFailure(id, options?)🔹	Return a CloudWatch Event Rule matching FAILED state.
onSuccess(id, options?)🔹	Create a CloudWatch Event Rule matching JobState.SUCCEEDED.
onTimeout(id, options?)🔹	Return a CloudWatch Event Rule matching TIMEOUT state.
toString()🔹	Returns a string representation of this construct.
protected buildJobArn(scope, jobName)🔹	Returns the job arn.
protected onStateChange(id, jobState, options?)🔹	Create a CloudWatch Event Rule for the transition into the input jobState.

---

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  1¤7 name of the metric typically prefixed with glue.driver., glue.<executorId>. or glue.ALL..
• type MetricType  1¤7 the metric type.
• props MetricOptions  1¤7 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

Return a CloudWatch Metric indicating job failure.

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

---

metricSuccess(props?)🔹

public metricSuccess(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Return a CloudWatch Metric indicating job success.

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

---

metricTimeout(props?)🔹

public metricTimeout(props?: MetricOptions): Metric

Parameters

• props MetricOptions

Returns

• Metric

Return a CloudWatch Metric indicating job timeout.

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

---

onEvent(id, options?)🔹

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

Parameters

• id string  1¤7 construct id.
• options OnEventOptions  1¤7 event options.

Returns

• Rule

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

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  1¤7 construct id.
• options OnEventOptions  1¤7 optional event options.

Returns

• Rule

Return a CloudWatch Event Rule matching FAILED state.

---

onSuccess(id, options?)🔹

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

Parameters

• id string  1¤7 construct id.
• options OnEventOptions  1¤7 optional event options.

Returns

• Rule

Create a CloudWatch Event Rule matching JobState.SUCCEEDED.

---

onTimeout(id, options?)🔹

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

Parameters

• id string  1¤7 construct id.
• options OnEventOptions  1¤7 optional event options.

Returns

• Rule

Return a CloudWatch Event Rule matching TIMEOUT state.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

protected buildJobArn(scope, jobName)🔹

protected buildJobArn(scope: Construct, jobName: string): string

Parameters

• scope Construct
• jobName string

Returns

• string

Returns the job arn.

---

protected onStateChange(id, jobState, options?)🔹

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

Parameters

• id string  1¤7 construct id.
• jobState JobState  1¤7 the job state.
• options OnEventOptions  1¤7 optional event options.

Returns

• Rule

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