Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

@aws-cdk/aws-glue-alpha

The CDK Construct Library for AWS::Glue


AWS icon

AWS

Author Amazon Web Services

Published

Repository github.com

License Apache-2.0

Registry www.npmjs.com


npm install @aws-cdk/aws-glue-alpha@2.195.0-alpha.0

IJob

Interface representing a new or an imported Glue Job.

Methods

NameDescription
metricCreate a CloudWatch metric.
metricFailureCreate a CloudWatch Metric indicating job failure.
metricSuccessCreate a CloudWatch Metric indicating job success.
metricTimeoutCreate a CloudWatch Metric indicating job timeout.
onEventDefines a CloudWatch event rule triggered when something happens with this job.
onFailureDefines a CloudWatch event rule triggered when this job moves to the FAILED state.
onSuccessDefines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
onTimeoutDefines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.
metric
public metric(metricName: string, type: MetricType, props?: MetricOptions): Metric

Create a CloudWatch metric.

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

metricNameRequired
  • Type: string

name of the metric typically prefixed with glue.driver., glue.<executorId>. or glue.ALL..

typeRequired

the metric type.

propsOptional

metric options.

metricFailure
public metricFailure(props?: MetricOptions): Metric

Create a CloudWatch Metric indicating job failure.

propsOptional
metricSuccess
public metricSuccess(props?: MetricOptions): Metric

Create a CloudWatch Metric indicating job success.

propsOptional
metricTimeout
public metricTimeout(props?: MetricOptions): Metric

Create a CloudWatch Metric indicating job timeout.

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

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

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

idRequired
  • Type: string
optionsOptional
onFailure
public onFailure(id: string, options?: OnEventOptions): Rule

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

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

idRequired
  • Type: string
optionsOptional
onSuccess
public onSuccess(id: string, options?: OnEventOptions): Rule

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

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

idRequired
  • Type: string
optionsOptional
onTimeout
public onTimeout(id: string, options?: OnEventOptions): Rule

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

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

idRequired
  • Type: string
optionsOptional

Properties

NameTypeDescription
nodeNodeThe tree node.
envResourceEnvironmentThe environment this resource belongs to.
stackStackThe stack in which this resource is defined.
grantPrincipalIPrincipalThe principal to grant permissions to.
jobArnstringThe ARN of the job.
jobNamestringThe name of the job.
nodeRequired
public readonly node: Node;

The tree node.

envRequired
public readonly env: 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.

stackRequired
public readonly stack: Stack;

The stack in which this resource is defined.

grantPrincipalRequired
public readonly grantPrincipal: IPrincipal;

The principal to grant permissions to.

jobArnRequired
public readonly jobArn: string;
  • Type: string

The ARN of the job.

jobNameRequired
public readonly jobName: string;
  • Type: string

The name of the job.