Syntax Properties Return values Examples

AWS::Glue::Job

The AWS::Glue::Job resource specifies an Amazon Glue job in the data catalog. For more information, see Adding Jobs in Amazon Glue and Job Structure in the Amazon Glue Developer Guide.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON


{
  "Type" : "AWS::Glue::Job",
  "Properties" : {
      "AllocatedCapacity" : Double,
      "Command" : JobCommand,
      "Connections" : ConnectionsList,
      "DefaultArguments" : Json,
      "Description" : String,
      "ExecutionClass" : String,
      "ExecutionProperty" : ExecutionProperty,
      "GlueVersion" : String,
      "LogUri" : String,
      "MaxCapacity" : Double,
      "MaxRetries" : Double,
      "Name" : String,
      "NonOverridableArguments" : Json,
      "NotificationProperty" : NotificationProperty,
      "NumberOfWorkers" : Integer,
      "Role" : String,
      "SecurityConfiguration" : String,
      "Tags" : Json,
      "Timeout" : Integer,
      "WorkerType" : String
    }
}

YAML


Type: AWS::Glue::Job
Properties: 
  AllocatedCapacity: Double
  Command: 
    JobCommand
  Connections: 
    ConnectionsList
  DefaultArguments: Json
  Description: String
  ExecutionClass: String
  ExecutionProperty: 
    ExecutionProperty
  GlueVersion: String
  LogUri: String
  MaxCapacity: Double
  MaxRetries: Double
  Name: String
  NonOverridableArguments: Json
  NotificationProperty: 
    NotificationProperty
  NumberOfWorkers: Integer
  Role: String
  SecurityConfiguration: String
  Tags: Json
  Timeout: Integer
  WorkerType: String

Properties

AllocatedCapacity

This parameter is no longer supported. Use MaxCapacity instead.

The number of capacity units that are allocated to this job.

Required: No

Type: Double

Update requires: No interruption

Command

The code that executes a job.

Required: Yes

Type: JobCommand

Update requires: No interruption

Connections

The connections used for this job.

Required: No

Type: ConnectionsList

Update requires: No interruption

DefaultArguments

The default arguments for this job, specified as name-value pairs.

You can specify arguments here that your own job-execution script consumes, in addition to arguments that Amazon Glue itself consumes.

For information about how to specify and consume your own job arguments, see Calling Amazon Glue APIs in Python in the Amazon Glue Developer Guide.

For information about the key-value pairs that Amazon Glue consumes to set up your job, see Special Parameters Used by Amazon Glue in the Amazon Glue Developer Guide.

Required: No

Type: Json

Update requires: No interruption

Description

A description of the job.

Required: No

Type: String

Minimum: 0

Maximum: 2048

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Update requires: No interruption

ExecutionClass

Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.

The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.

Only jobs with Amazon Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.

Required: No

Type: String

Update requires: No interruption

ExecutionProperty

The maximum number of concurrent runs that are allowed for this job.

Required: No

Type: ExecutionProperty

Update requires: No interruption

GlueVersion

Glue version determines the versions of Apache Spark and Python that Amazon Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available Amazon Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.

Jobs that are created without specifying a Glue version default to Glue 0.9.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: ^\w+\.\w+$

Update requires: No interruption

LogUri

This field is reserved for future use.

Required: No

Type: String

Update requires: No interruption

MaxCapacity

The number of Amazon Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory.

Do not set Max Capacity if using WorkerType and NumberOfWorkers.

The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:

When you specify a Python shell job (JobCommand.Name="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
When you specify an Apache Spark ETL job (JobCommand.Name="glueetl"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.

Required: No

Type: Double

Update requires: No interruption

MaxRetries

The maximum number of times to retry this job after a JobRun fails.

Required: No

Type: Double

Update requires: No interruption

Name

The name you assign to this job definition.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Update requires: Replacement

NonOverridableArguments

Non-overridable arguments for this job, specified as name-value pairs.

Required: No

Type: Json

Update requires: No interruption

NotificationProperty

Specifies configuration properties of a notification.

Required: No

Type: NotificationProperty

Update requires: No interruption

NumberOfWorkers

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X, and 149 for G.2X.

Required: No

Type: Integer

Update requires: No interruption

Role

The name or Amazon Resource Name (ARN) of the IAM role associated with this job.

Required: Yes

Type: String

Update requires: No interruption

SecurityConfiguration

The name of the SecurityConfiguration structure to be used with this job.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*

Update requires: No interruption

Tags

The tags to use with this job.

Required: No

Type: Json

Update requires: No interruption

Timeout

The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours).

Required: No

Type: Integer

Update requires: No interruption

WorkerType

The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, or G.2X.

For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
For the G.1X worker type, each worker maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.

Required: No

Type: String

Allowed values: G.025X | G.1X | G.2X | Standard

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the job name.

For more information about using the Reffunction, see Ref.

Examples

The following example creates a job with an associated role. The ScriptLocation is an Amazon S3 location. The example provided below is a placeholder for your Amazon S3 location.

JSON


{
  "Description": "Amazon Glue Job Test",
  "Resources": {
    "MyJobRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Version": "2012-10-17",
          "Statement": [
            {
              "Effect": "Allow",
              "Principal": {
                "Service": [
                  "glue.amazonaws.com"
                ]
              },
              "Action": [
                "sts:AssumeRole"
              ]
            }
          ]
        },
        "Path": "/",
        "Policies": [
          {
            "PolicyName": "root",
            "PolicyDocument": {
              "Version": "2012-10-17",
              "Statement": [
                {
                  "Effect": "Allow",
                  "Action": "*",
                  "Resource": "*"
                }
              ]
            }
          }
        ]
      }
    },
    "MyJob": {
      "Type": "AWS::Glue::Job",
      "Properties": {
        "Command": {
          "Name": "glueetl",
          "ScriptLocation": "s3://<your-S3-script-uri>"
        },
        "DefaultArguments": {
          "--job-bookmark-option": "job-bookmark-enable"
        },
        "ExecutionProperty": {
          "MaxConcurrentRuns": 2
        },
        "MaxRetries": 0,
        "Name": "cf-job1",
        "Role": {
          "Ref": "MyJobRole"
        }
      }
    }
  }
}

YAML


---
Description: "Amazon Glue Job Test"
Resources:
  MyJobRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Version: "2012-10-17"
        Statement:
          -
            Effect: "Allow"
            Principal:
              Service:
                - "glue.amazonaws.com"
            Action:
              - "sts:AssumeRole"
      Path: "/"
      Policies:
        -
          PolicyName: "root"
          PolicyDocument:
            Version: "2012-10-17"
            Statement:
              -
                Effect: "Allow"
                Action: "*"
                Resource: "*"
 
  MyJob:
    Type: AWS::Glue::Job
    Properties:
      Command:
        Name: glueetl
        ScriptLocation: "s3://<your-S3-script-uri>"
      DefaultArguments:
        "--job-bookmark-option": "job-bookmark-enable"
      ExecutionProperty:
        MaxConcurrentRuns: 2
      MaxRetries: 0
      Name: cf-job1
      Role: !Ref MyJobRole

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

AWS::Glue::DevEndpoint

ConnectionsList