Interface IJob

(experimental) Interface representing a new or an imported Glue Job.

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Env

IResource.Stack

IGrantable.GrantPrincipal

Namespace: Amazon.CDK.AWS.Glue.Alpha

Assembly: Amazon.CDK.AWS.Glue.Alpha.dll

Syntax (csharp)

public interface IJob : IResource, IConstruct, IDependable, IGrantable

Syntax (vb)

Public Interface IJob Inherits IResource, IConstruct, IDependable, IGrantable

Remarks

Stability: Experimental

Synopsis

Properties

JobArn	(experimental) The ARN of the job.
JobName	(experimental) The name of the job.

Methods

Metric(string, MetricType, IMetricOptions?)	(experimental) Create a CloudWatch metric.
MetricFailure(IMetricOptions?)	(experimental) Create a CloudWatch Metric indicating job failure.
MetricSuccess(IMetricOptions?)	(experimental) Create a CloudWatch Metric indicating job success.
MetricTimeout(IMetricOptions?)	(experimental) Create a CloudWatch Metric indicating job timeout.
OnEvent(string, IOnEventOptions?)	(experimental) Defines a CloudWatch event rule triggered when something happens with this job.
OnFailure(string, IOnEventOptions?)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.
OnSuccess(string, IOnEventOptions?)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
OnTimeout(string, IOnEventOptions?)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Properties

JobArn

(experimental) The ARN of the job.

string JobArn { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

JobName

(experimental) The name of the job.

string JobName { get; }

Property Value

string

Remarks

Stability: Experimental

Attribute: true

Methods

Metric(string, MetricType, IMetricOptions?)

(experimental) Create a CloudWatch metric.

Metric Metric(string metricName, MetricType type, IMetricOptions? props = null)

Parameters

metricName string

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

type MetricType

the metric type.

props IMetricOptions

metric options.

Returns

Metric

Remarks

Stability: Experimental

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

MetricFailure(IMetricOptions?)

(experimental) Create a CloudWatch Metric indicating job failure.

Metric MetricFailure(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricSuccess(IMetricOptions?)

(experimental) Create a CloudWatch Metric indicating job success.

Metric MetricSuccess(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

MetricTimeout(IMetricOptions?)

(experimental) Create a CloudWatch Metric indicating job timeout.

Metric MetricTimeout(IMetricOptions? props = null)

Parameters

props IMetricOptions

Returns

Metric

Remarks

Stability: Experimental

OnEvent(string, IOnEventOptions?)

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

Rule OnEvent(string id, IOnEventOptions? options = null)

Parameters

id string

options IOnEventOptions

Returns

Rule

Remarks

Stability: Experimental

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

OnFailure(string, IOnEventOptions?)

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

Rule OnFailure(string id, IOnEventOptions? options = null)

Parameters

id string

options IOnEventOptions

Returns

Rule

Remarks

Stability: Experimental

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

OnSuccess(string, IOnEventOptions?)

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

Rule OnSuccess(string id, IOnEventOptions? options = null)

Parameters

id string

options IOnEventOptions

Returns

Rule

Remarks

Stability: Experimental

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

OnTimeout(string, IOnEventOptions?)

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

Rule OnTimeout(string id, IOnEventOptions? options = null)

Parameters

id string

options IOnEventOptions

Returns

Rule

Remarks

Stability: Experimental

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