Interface IJobQueue
Represents a JobQueue.
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IJobQueue : IResource, IConstruct, IDependable, IEnvironmentAwareSyntax (vb)
Public Interface IJobQueue Inherits IResource, IConstruct, IDependable, IEnvironmentAwareSynopsis
Properties
| ComputeEnvironments | The set of compute environments mapped to a job queue and their order relative to each other. |
| Enabled | If the job queue is enabled, it is able to accept jobs. |
| JobQueueArn | The ARN of this job queue. |
| JobQueueName | The name of the job queue. |
| Priority | The priority of the job queue. |
| SchedulingPolicy | The SchedulingPolicy for this JobQueue. |
Methods
| AddComputeEnvironment(IComputeEnvironment, double) | Add a |
Properties
ComputeEnvironments
The set of compute environments mapped to a job queue and their order relative to each other.
IOrderedComputeEnvironment[] ComputeEnvironments { get; }Property Value
Remarks
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
If the job queue is enabled, it is able to accept jobs.
bool? Enabled { get; }Property Value
bool?
Remarks
Otherwise, new jobs can't be added to the queue, but jobs already in the queue can finish.
Default: true
JobQueueArn
The ARN of this job queue.
string JobQueueArn { get; }Property Value
Remarks
Attribute: true
JobQueueName
The name of the job queue.
string JobQueueName { get; }Property Value
Remarks
It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_)
Attribute: true
Priority
The priority of the job queue.
double Priority { get; }Property Value
Remarks
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.
SchedulingPolicy
The SchedulingPolicy for this JobQueue.
ISchedulingPolicy? SchedulingPolicy { get; }Property Value
Remarks
Instructs the Scheduler how to schedule different jobs.
Default: - no scheduling policy
Methods
AddComputeEnvironment(IComputeEnvironment, double)
Add a ComputeEnvironment to this Queue.
void AddComputeEnvironment(IComputeEnvironment computeEnvironment, double order)Parameters
- computeEnvironment IComputeEnvironment
- order double
Remarks
The Queue will prefer lower-order ComputeEnvironments.