Package software.amazon.awscdk.services.batch

Interface IJobQueue

All Superinterfaces:

software.constructs.IConstruct, software.constructs.IDependable, IResource, software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IJobQueue.Jsii$Default

All Known Implementing Classes:

IJobQueue.Jsii$Proxy, JobQueue

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:55.453Z")
@Stability(Stable)
public interface IJobQueue
extends software.amazon.jsii.JsiiSerializable, IResource

Represents a JobQueue.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IJobQueue.Jsii$Default	Internal default implementation for IJobQueue.
static final class	IJobQueue.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
void	addComputeEnvironment(IComputeEnvironment computeEnvironment, Number order)	Add a ComputeEnvironment to this Queue.
List<OrderedComputeEnvironment>	getComputeEnvironments()	The set of compute environments mapped to a job queue and their order relative to each other.
default Boolean	getEnabled()	If the job queue is enabled, it is able to accept jobs.
String	getJobQueueArn()	The ARN of this job queue.
String	getJobQueueName()	The name of the job queue.
Number	getPriority()	The priority of the job queue.
default ISchedulingPolicy	getSchedulingPolicy()	The SchedulingPolicy for this JobQueue.

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComputeEnvironments

@Stability(Stable)
@NotNull
List<OrderedComputeEnvironment> getComputeEnvironments()

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.

getJobQueueArn

@Stability(Stable)
@NotNull
String getJobQueueArn()

The ARN of this job queue.

getJobQueueName

@Stability(Stable)
@NotNull
String getJobQueueName()

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

getPriority

@Stability(Stable)
@NotNull
Number getPriority()

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.

getEnabled

@Stability(Stable)
@Nullable
default Boolean getEnabled()

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.

Default: true

getSchedulingPolicy

@Stability(Stable)
@Nullable
default ISchedulingPolicy getSchedulingPolicy()

The SchedulingPolicy for this JobQueue.

Instructs the Scheduler how to schedule different jobs.

Default: - no scheduling policy

addComputeEnvironment

@Stability(Stable)
void addComputeEnvironment(@NotNull
 IComputeEnvironment computeEnvironment,
 @NotNull
 Number order)

Add a ComputeEnvironment to this Queue.

The Queue will prefer lower-order ComputeEnvironments.

Parameters:

computeEnvironment - This parameter is required.

order - This parameter is required.