@aws-cdk_aws-batch-alpha.JobQueueProps

interface JobQueueProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.Batch.Alpha.JobQueueProps
Gogithub.com/aws/aws-cdk-go/awscdkbatchalpha/v2#JobQueueProps
Javasoftware.amazon.awscdk.services.batch.alpha.JobQueueProps
Pythonaws_cdk.aws_batch_alpha.JobQueueProps
TypeScript (source)@aws-cdk/aws-batch-alpha ยป JobQueueProps

Props to configure a JobQueue.

Example

declare const vpc: ec2.IVpc;
const sharedComputeEnv = new batch.FargateComputeEnvironment(this, 'spotEnv', {
  vpc,
  spot: true,
});
const lowPriorityQueue = new batch.JobQueue(this, 'JobQueue', {
   priority: 1,
});
const highPriorityQueue = new batch.JobQueue(this, 'JobQueue', {
   priority: 10,
});
lowPriorityQueue.addComputeEnvironment(sharedComputeEnv, 1);
highPriorityQueue.addComputeEnvironment(sharedComputeEnv, 1);

Properties

NameTypeDescription
computeEnvironments?๐Ÿ”นOrderedComputeEnvironment[]The set of compute environments mapped to a job queue and their order relative to each other.
enabled?๐Ÿ”นbooleanIf the job queue is enabled, it is able to accept jobs.
jobQueueName?๐Ÿ”นstringThe name of the job queue.
priority?๐Ÿ”นnumberThe priority of the job queue.
schedulingPolicy?๐Ÿ”นISchedulingPolicyThe SchedulingPolicy for this JobQueue.

computeEnvironments?๐Ÿ”น

Type: OrderedComputeEnvironment[] (optional, default: none)

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.


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.


jobQueueName?๐Ÿ”น

Type: string (optional, default: no name)

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 (_)


priority?๐Ÿ”น

Type: number (optional, default: 1)

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


schedulingPolicy?๐Ÿ”น

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

The SchedulingPolicy for this JobQueue.

Instructs the Scheduler how to schedule different jobs.