JobQueue
JobQueues can receive Jobs, which are removed from the queue when sent to the linked ComputeEnvironment(s) to be executed. Jobs exit the queue in FIFO order unless a `SchedulingPolicy` is linked.
Import
import { JobQueue } from 'aws-cdk-lib/aws-batch';Or use the module namespace:
import * as batch from 'aws-cdk-lib/aws-batch';
// batch.JobQueueProperties
Configuration passed to the constructor as JobQueueProps.
computeEnvironmentsOptionalOrderedComputeEnvironment[]The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed. *Note*: All compute environments that are associated with a job queue must share the same architecture. AWS Batch doesn't support mixing compute environment architecture types in a single job queue.
Default: none
enabledOptionalbooleanIf the job queue is enabled, it is able to accept jobs. Otherwise, new jobs can't be added to the queue, but jobs already in the queue can finish.
Default: true
jobQueueNameOptionalstringThe name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)
Default: - no name
jobStateTimeLimitActionsOptionalJobStateTimeLimitAction[]The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.
Default: - no actions
priorityOptionalnumberThe priority of the job queue. Job queues with a higher priority are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority of 10 is given scheduling preference over a job queue with a priority of 1.
Default: 1
schedulingPolicyOptionalISchedulingPolicyRefThe SchedulingPolicy for this JobQueue. Instructs the Scheduler how to schedule different jobs.
Default: - no scheduling policy
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-batch