interface IJobQueue

Language	Type name
.NET	Amazon.CDK.AWS.Batch.IJobQueue
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#IJobQueue
Java	software.amazon.awscdk.services.batch.IJobQueue
Python	aws_cdk.aws_batch.IJobQueue
TypeScript (source)	aws-cdk-lib » aws_batch » IJobQueue

Implemented by JobQueue

Obtainable from JobQueue.fromJobQueueArn()

Represents a JobQueue.

Properties

Name	Type	Description
computeEnvironments	OrderedComputeEnvironment[]	The set of compute environments mapped to a job queue and their order relative to each other.
env	ResourceEnvironment	The environment this resource belongs to.
jobQueueArn	string	The ARN of this job queue.
jobQueueName	string	The name of the job queue.
node	Node	The tree node.
priority	number	The priority of the job queue.
stack	Stack	The stack in which this resource is defined.
enabled?	boolean	If the job queue is enabled, it is able to accept jobs.
schedulingPolicy?	ISchedulingPolicy	The SchedulingPolicy for this JobQueue.

---

computeEnvironments

Type: OrderedComputeEnvironment[]

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.

---

env

Type: ResourceEnvironment

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.

---

jobQueueArn

Type: string

The ARN of this job queue.

---

jobQueueName

Type: string

The name of the job queue.

It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)

---

node

Type: Node

The tree node.

---

priority

Type: number

The 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 value of 10 is given scheduling preference over a job queue with a priority value of 1.

---

stack

Type: Stack

The stack in which this resource is defined.

---

enabled?

Type: boolean (optional, default: true)

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

---

schedulingPolicy?

Type: ISchedulingPolicy (optional, default: no scheduling policy)

The SchedulingPolicy for this JobQueue.

Instructs the Scheduler how to schedule different jobs.

Methods

Name	Description
addComputeEnvironment(computeEnvironment, order)	Add a ComputeEnvironment to this Queue.
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.

---

addComputeEnvironment(computeEnvironment, order)

public addComputeEnvironment(computeEnvironment: IComputeEnvironment, order: number): void

Parameters

• computeEnvironment IComputeEnvironment
• order number

Add a ComputeEnvironment to this Queue.

The Queue will prefer lower-order ComputeEnvironments.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

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