1.204.0

interface JobQueueProps 🔹

LanguageType name
.NETAmazon.CDK.AWS.Batch.JobQueueProps
Javasoftware.amazon.awscdk.services.batch.JobQueueProps
Pythonaws_cdk.aws_batch.JobQueueProps
TypeScript (source)@aws-cdk/aws-batch » JobQueueProps

Properties of a batch job queue.

Example

declare const sharedComputeEnvs: batch.ComputeEnvironment;
const highPrioQueue = new batch.JobQueue(this, 'JobQueue', {
  computeEnvironments: [{
    computeEnvironment: sharedComputeEnvs,
    order: 1,
  }],
  priority: 2,
});

const lowPrioQueue = new batch.JobQueue(this, 'JobQueue', {
  computeEnvironments: [{
    computeEnvironment: sharedComputeEnvs,
    order: 1,
  }],
  priority: 1,
});

Properties

NameTypeDescription
computeEnvironments🔹JobQueueComputeEnvironment[]The set of compute environments mapped to a job queue and their order relative to each other.
enabled?🔹booleanThe state of the job queue.
jobQueueName?🔹stringA name for the job queue.
priority?🔹numberThe priority of the job queue.

computeEnvironments🔹

Type: JobQueueComputeEnvironment[]

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 should execute a given 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.

enabled?🔹

Type: boolean (optional, default: true)

The state of the job queue.

If set to true, it is able to accept jobs.

jobQueueName?🔹

Type: string (optional, default: Cloudformation-generated name)

A name for the job queue.

Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

priority?🔹

Type: number (optional, default: 1)

The priority of the job queue.

Job queues with a higher priority (or a higher integer value for the priority parameter) 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.

← PreviousNext →