@aws-cdk_aws-batch-alpha.JobQueue

class JobQueue (construct) ๐Ÿ”น

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

Implements IConstruct, IDependable, IResource, IJobQueue

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.

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

Initializer

new JobQueue(scope: Construct, id: string, props?: JobQueueProps)

Parameters

  • scope Construct
  • id string
  • props JobQueueProps

Construct Props

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.

Properties

NameTypeDescription
computeEnvironments๐Ÿ”นOrderedComputeEnvironment[]The set of compute environments mapped to a job queue and their order relative to each other.
env๐Ÿ”นResourceEnvironmentThe environment this resource belongs to.
jobQueueArn๐Ÿ”นstringThe ARN of this job queue.
jobQueueName๐Ÿ”นstringThe name of the job queue.
node๐Ÿ”นNodeThe tree node.
priority๐Ÿ”นnumberThe priority of the job queue.
stack๐Ÿ”นStackThe stack in which this resource is defined.
enabled?๐Ÿ”นbooleanIf the job queue is enabled, it is able to accept jobs.
schedulingPolicy?๐Ÿ”นISchedulingPolicyThe 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)

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)

The SchedulingPolicy for this JobQueue.

Instructs the Scheduler how to schedule different jobs.

Methods

NameDescription
addComputeEnvironment(computeEnvironment, order)๐Ÿ”นAdd a ComputeEnvironment to this Queue.
applyRemovalPolicy(policy)๐Ÿ”นApply the given removal policy to this resource.
toString()๐Ÿ”นReturns a string representation of this construct.
static fromJobQueueArn(scope, id, jobQueueArn)๐Ÿ”นrefer to an existing JobQueue by its arn.

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


toString()๐Ÿ”น

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static fromJobQueueArn(scope, id, jobQueueArn)๐Ÿ”น

public static fromJobQueueArn(scope: Construct, id: string, jobQueueArn: string): IJobQueue

Parameters

  • scope Construct
  • id string
  • jobQueueArn string

Returns

  • IJobQueue

refer to an existing JobQueue by its arn.