Package software.amazon.awscdk.services.glue

Class CfnJob

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnJob
All Implemented Interfaces:
IInspectable, IJobRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:37.507Z") @Stability(Stable) public class CfnJob extends CfnResource implements IInspectable, IJobRef, ITaggable
The AWS::Glue::Job resource specifies an AWS Glue job in the data catalog.

For more information, see Adding Jobs in AWS Glue and Job Structure in the AWS Glue Developer Guide.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object defaultArguments;
 Object nonOverridableArguments;
 Object tags;
 CfnJob cfnJob = CfnJob.Builder.create(this, "MyCfnJob")
         .command(JobCommandProperty.builder()
                 .name("name")
                 .pythonVersion("pythonVersion")
                 .runtime("runtime")
                 .scriptLocation("scriptLocation")
                 .build())
         .role("role")
         // the properties below are optional
         .allocatedCapacity(123)
         .connections(ConnectionsListProperty.builder()
                 .connections(List.of("connections"))
                 .build())
         .defaultArguments(defaultArguments)
         .description("description")
         .executionClass("executionClass")
         .executionProperty(ExecutionPropertyProperty.builder()
                 .maxConcurrentRuns(123)
                 .build())
         .glueVersion("glueVersion")
         .jobMode("jobMode")
         .jobRunQueuingEnabled(false)
         .logUri("logUri")
         .maintenanceWindow("maintenanceWindow")
         .maxCapacity(123)
         .maxRetries(123)
         .name("name")
         .nonOverridableArguments(nonOverridableArguments)
         .notificationProperty(NotificationPropertyProperty.builder()
                 .notifyDelayAfter(123)
                 .build())
         .numberOfWorkers(123)
         .securityConfiguration("securityConfiguration")
         .tags(tags)
         .timeout(123)
         .workerType("workerType")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnJob

      protected CfnJob(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnJob

      protected CfnJob(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnJob

      @Stability(Stable) public CfnJob(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnJobProps props)
      Create a new AWS::Glue::Job.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForJob

      @Stability(Stable) @NotNull public static String arnForJob(@NotNull IJobRef resource)
      Parameters:
      resource - This parameter is required.

    • fromJobName

      @Stability(Stable) @NotNull public static IJobRef fromJobName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String jobName)
      Creates a new IJobRef from a jobName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      jobName - This parameter is required.

    • isCfnJob

      @Stability(Stable) @NotNull public static Boolean isCfnJob(@NotNull Object x)
      Checks whether the given object is a CfnJob.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getJobRef

      @Stability(Stable) @NotNull public JobReference getJobRef()
      A reference to a Job resource.
      Specified by:
      getJobRef in interface IJobRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCommand

      @Stability(Stable) @NotNull public Object getCommand()
      The code that executes a job.

      Returns union: either IResolvable or CfnJob.JobCommandProperty

    • setCommand

      @Stability(Stable) public void setCommand(@NotNull IResolvable value)
      The code that executes a job.

    • setCommand

      @Stability(Stable) public void setCommand(@NotNull CfnJob.JobCommandProperty value)
      The code that executes a job.

    • getRole

      @Stability(Stable) @NotNull public String getRole()
      The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

    • setRole

      @Stability(Stable) public void setRole(@NotNull String value)
      The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

    • getAllocatedCapacity

      @Stability(Stable) @Nullable public Number getAllocatedCapacity()
      This parameter is no longer supported.

      Use MaxCapacity instead.

    • setAllocatedCapacity

      @Stability(Stable) public void setAllocatedCapacity(@Nullable Number value)
      This parameter is no longer supported.

      Use MaxCapacity instead.

    • getConnections

      @Stability(Stable) @Nullable public Object getConnections()
      The connections used for this job.

      Returns union: either IResolvable or CfnJob.ConnectionsListProperty

    • setConnections

      @Stability(Stable) public void setConnections(@Nullable IResolvable value)
      The connections used for this job.

    • setConnections

      @Stability(Stable) public void setConnections(@Nullable CfnJob.ConnectionsListProperty value)
      The connections used for this job.

    • getDefaultArguments

      @Stability(Stable) @Nullable public Object getDefaultArguments()
      The default arguments for this job, specified as name-value pairs.

    • setDefaultArguments

      @Stability(Stable) public void setDefaultArguments(@Nullable Object value)
      The default arguments for this job, specified as name-value pairs.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the job.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the job.

    • getExecutionClass

      @Stability(Stable) @Nullable public String getExecutionClass()
      Indicates whether the job is run with a standard or flexible execution class.

    • setExecutionClass

      @Stability(Stable) public void setExecutionClass(@Nullable String value)
      Indicates whether the job is run with a standard or flexible execution class.

    • getExecutionProperty

      @Stability(Stable) @Nullable public Object getExecutionProperty()
      The maximum number of concurrent runs that are allowed for this job.

      Returns union: either IResolvable or CfnJob.ExecutionPropertyProperty

    • setExecutionProperty

      @Stability(Stable) public void setExecutionProperty(@Nullable IResolvable value)
      The maximum number of concurrent runs that are allowed for this job.

    • setExecutionProperty

      @Stability(Stable) public void setExecutionProperty(@Nullable CfnJob.ExecutionPropertyProperty value)
      The maximum number of concurrent runs that are allowed for this job.

    • getGlueVersion

      @Stability(Stable) @Nullable public String getGlueVersion()
      Glue version determines the versions of Apache Spark and Python that AWS Glue supports.

    • setGlueVersion

      @Stability(Stable) public void setGlueVersion(@Nullable String value)
      Glue version determines the versions of Apache Spark and Python that AWS Glue supports.

    • getJobMode

      @Stability(Stable) @Nullable public String getJobMode()
      A mode that describes how a job was created.

      Valid values are:.

    • setJobMode

      @Stability(Stable) public void setJobMode(@Nullable String value)
      A mode that describes how a job was created.

      Valid values are:.

    • getJobRunQueuingEnabled

      @Stability(Stable) @Nullable public Object getJobRunQueuingEnabled()
      Specifies whether job run queuing is enabled for the job runs for this job.

      Returns union: either Boolean or IResolvable

    • setJobRunQueuingEnabled

      @Stability(Stable) public void setJobRunQueuingEnabled(@Nullable Boolean value)
      Specifies whether job run queuing is enabled for the job runs for this job.

    • setJobRunQueuingEnabled

      @Stability(Stable) public void setJobRunQueuingEnabled(@Nullable IResolvable value)
      Specifies whether job run queuing is enabled for the job runs for this job.

    • getLogUri

      @Stability(Stable) @Nullable public String getLogUri()
      This field is reserved for future use.

    • setLogUri

      @Stability(Stable) public void setLogUri(@Nullable String value)
      This field is reserved for future use.

    • getMaintenanceWindow

      @Stability(Stable) @Nullable public String getMaintenanceWindow()
      This field specifies a day of the week and hour for a maintenance window for streaming jobs.

    • setMaintenanceWindow

      @Stability(Stable) public void setMaintenanceWindow(@Nullable String value)
      This field specifies a day of the week and hour for a maintenance window for streaming jobs.

    • getMaxCapacity

      @Stability(Stable) @Nullable public Number getMaxCapacity()
      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.

    • setMaxCapacity

      @Stability(Stable) public void setMaxCapacity(@Nullable Number value)
      The number of AWS Glue data processing units (DPUs) that can be allocated when this job runs.

    • getMaxRetries

      @Stability(Stable) @Nullable public Number getMaxRetries()
      The maximum number of times to retry this job after a JobRun fails.

    • setMaxRetries

      @Stability(Stable) public void setMaxRetries(@Nullable Number value)
      The maximum number of times to retry this job after a JobRun fails.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name you assign to this job definition.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name you assign to this job definition.

    • getNonOverridableArguments

      @Stability(Stable) @Nullable public Object getNonOverridableArguments()
      Non-overridable arguments for this job, specified as name-value pairs.

    • setNonOverridableArguments

      @Stability(Stable) public void setNonOverridableArguments(@Nullable Object value)
      Non-overridable arguments for this job, specified as name-value pairs.

    • getNotificationProperty

      @Stability(Stable) @Nullable public Object getNotificationProperty()
      Specifies configuration properties of a notification.

      Returns union: either IResolvable or CfnJob.NotificationPropertyProperty

    • setNotificationProperty

      @Stability(Stable) public void setNotificationProperty(@Nullable IResolvable value)
      Specifies configuration properties of a notification.

    • setNotificationProperty

      @Stability(Stable) public void setNotificationProperty(@Nullable CfnJob.NotificationPropertyProperty value)
      Specifies configuration properties of a notification.

    • getNumberOfWorkers

      @Stability(Stable) @Nullable public Number getNumberOfWorkers()
      The number of workers of a defined workerType that are allocated when a job runs.

    • setNumberOfWorkers

      @Stability(Stable) public void setNumberOfWorkers(@Nullable Number value)
      The number of workers of a defined workerType that are allocated when a job runs.

    • getSecurityConfiguration

      @Stability(Stable) @Nullable public String getSecurityConfiguration()
      The name of the SecurityConfiguration structure to be used with this job.

    • setSecurityConfiguration

      @Stability(Stable) public void setSecurityConfiguration(@Nullable String value)
      The name of the SecurityConfiguration structure to be used with this job.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      The tags to use with this job.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      The tags to use with this job.

    • getTimeout

      @Stability(Stable) @Nullable public Number getTimeout()
      The job timeout in minutes.

    • setTimeout

      @Stability(Stable) public void setTimeout(@Nullable Number value)
      The job timeout in minutes.

    • getWorkerType

      @Stability(Stable) @Nullable public String getWorkerType()
      The type of predefined worker that is allocated when a job runs.

    • setWorkerType

      @Stability(Stable) public void setWorkerType(@Nullable String value)
      The type of predefined worker that is allocated when a job runs.