Package software.amazon.awscdk.services.glue.alpha

Interface IJob.Jsii$Default

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IJob, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

IJob.Jsii$Proxy

Enclosing interface:

IJob

@Internal
public static interface IJob.Jsii$Default
extends IJob, IResource.Jsii$Default, IGrantable.Jsii$Default

Internal default implementation for IJob.

Nested Class Summary

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IDependable

software.constructs.IDependable.Jsii$Default, software.constructs.IDependable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iam.IGrantable

IGrantable.Jsii$Default, IGrantable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.glue.alpha.IJob

IJob.Jsii$Default, IJob.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default, IResource.Jsii$Proxy

Method Summary

Modifier and Type	Method	Description
default void	applyRemovalPolicy(RemovalPolicy policy)	Apply the given removal policy to this resource.
default ResourceEnvironment	getEnv()	The environment this resource belongs to.
default IPrincipal	getGrantPrincipal()	The principal to grant permissions to.
default String	getJobArn()	(experimental) The ARN of the job.
default String	getJobName()	(experimental) The name of the job.
default software.constructs.Node	getNode()	The tree node.
default Stack	getStack()	The stack in which this resource is defined.
default Metric	metric(String metricName, MetricType type, MetricOptions props)	(experimental) Create a CloudWatch metric.
default Metric	metricFailure(MetricOptions props)	(experimental) Create a CloudWatch Metric indicating job failure.
default Metric	metricSuccess(MetricOptions props)	(experimental) Create a CloudWatch Metric indicating job success.
default Metric	metricTimeout(MetricOptions props)	(experimental) Create a CloudWatch Metric indicating job timeout.
default Rule	onEvent(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when something happens with this job.
default Rule	onFailure(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.
default Rule	onStateChange(String id, JobState jobState, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.
default Rule	onSuccess(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
default Rule	onTimeout(String id, OnEventOptions options)	(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Methods inherited from interface software.amazon.awscdk.services.glue.alpha.IJob

metric, metricFailure, metricSuccess, metricTimeout, onEvent, onFailure, onStateChange, onSuccess, onTimeout

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getNode

@Stability(Stable)
@NotNull
default software.constructs.Node getNode()

The tree node.

Specified by:

getNode in interface software.constructs.IConstruct

Specified by:

getNode in interface software.constructs.IConstruct.Jsii$Default

Specified by:

getNode in interface IResource.Jsii$Default

getEnv

@Stability(Stable)
@NotNull
default ResourceEnvironment getEnv()

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.

Specified by:

getEnv in interface IResource

Specified by:

getEnv in interface IResource.Jsii$Default

getStack

@Stability(Stable)
@NotNull
default Stack getStack()

The stack in which this resource is defined.

Specified by:

getStack in interface IResource

Specified by:

getStack in interface IResource.Jsii$Default

getGrantPrincipal

@Stability(Stable)
@NotNull
default IPrincipal getGrantPrincipal()

The principal to grant permissions to.

Specified by:

getGrantPrincipal in interface IGrantable

Specified by:

getGrantPrincipal in interface IGrantable.Jsii$Default

getJobArn

@Stability(Experimental)
@NotNull
default String getJobArn()

(experimental) The ARN of the job.

Specified by:

getJobArn in interface IJob

getJobName

@Stability(Experimental)
@NotNull
default String getJobName()

(experimental) The name of the job.

Specified by:

getJobName in interface IJob

applyRemovalPolicy

@Stability(Stable)
default void applyRemovalPolicy(@NotNull
 RemovalPolicy policy)

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).

Specified by:

applyRemovalPolicy in interface IResource

Specified by:

applyRemovalPolicy in interface IResource.Jsii$Default

Parameters:

policy - This parameter is required.

metric

@Stability(Experimental)
@NotNull
default Metric metric(@NotNull
 String metricName,
 @NotNull
 MetricType type,
 @Nullable
 MetricOptions props)

(experimental) Create a CloudWatch metric.

Specified by:

metric in interface IJob

Parameters:

metricName - name of the metric typically prefixed with glue.driver., glue.<executorId>. or glue.ALL.. This parameter is required.

type - the metric type. This parameter is required.

props - metric options.

See Also:

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

metricFailure

@Stability(Experimental)
@NotNull
default Metric metricFailure(@Nullable
 MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job failure.

Specified by:

metricFailure in interface IJob

Parameters:

props -

metricSuccess

@Stability(Experimental)
@NotNull
default Metric metricSuccess(@Nullable
 MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job success.

Specified by:

metricSuccess in interface IJob

Parameters:

props -

metricTimeout

@Stability(Experimental)
@NotNull
default Metric metricTimeout(@Nullable
 MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job timeout.

Specified by:

metricTimeout in interface IJob

Parameters:

props -

onEvent

@Stability(Experimental)
@NotNull
default Rule onEvent(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Specified by:

onEvent in interface IJob

Parameters:

id - This parameter is required.

options -

See Also:

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

onFailure

@Stability(Experimental)
@NotNull
default Rule onFailure(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Specified by:

onFailure in interface IJob

Parameters:

id - This parameter is required.

options -

See Also:

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

onStateChange

@Stability(Experimental)
@NotNull
default Rule onStateChange(@NotNull
 String id,
 @NotNull
 JobState jobState,
 @Nullable
 OnEventOptions options)

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

Specified by:

onStateChange in interface IJob

Parameters:

id - This parameter is required.

jobState - This parameter is required.

options -

See Also:

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

onSuccess

@Stability(Experimental)
@NotNull
default Rule onSuccess(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Specified by:

onSuccess in interface IJob

Parameters:

id - This parameter is required.

options -

See Also:

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

onTimeout

@Stability(Experimental)
@NotNull
default Rule onTimeout(@NotNull
 String id,
 @Nullable
 OnEventOptions options)

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

Specified by:

onTimeout in interface IJob

Parameters:

id - This parameter is required.

options -

See Also:

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