Class JobQueueProps
(experimental) Properties of a batch job queue.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Batch
Assembly: Amazon.CDK.AWS.Batch.dll
Syntax (csharp)
public class JobQueueProps : Object, IJobQueueProps
Syntax (vb)
Public Class JobQueueProps
Inherits Object
Implements IJobQueueProps
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
ComputeEnvironment sharedComputeEnvs;
var highPrioQueue = new JobQueue(this, "JobQueue", new JobQueueProps {
ComputeEnvironments = new [] { new JobQueueComputeEnvironment {
ComputeEnvironment = sharedComputeEnvs,
Order = 1
} },
Priority = 2
});
var lowPrioQueue = new JobQueue(this, "JobQueue", new JobQueueProps {
ComputeEnvironments = new [] { new JobQueueComputeEnvironment {
ComputeEnvironment = sharedComputeEnvs,
Order = 1
} },
Priority = 1
});
Synopsis
Constructors
JobQueueProps() |
Properties
ComputeEnvironments | (experimental) The set of compute environments mapped to a job queue and their order relative to each other. |
Enabled | (experimental) The state of the job queue. |
JobQueueName | (experimental) A name for the job queue. |
Priority | (experimental) The priority of the job queue. |
Constructors
JobQueueProps()
public JobQueueProps()
Properties
ComputeEnvironments
(experimental) The set of compute environments mapped to a job queue and their order relative to each other.
public IJobQueueComputeEnvironment[] ComputeEnvironments { get; set; }
Property Value
Remarks
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.
Stability: Experimental
Enabled
(experimental) The state of the job queue.
public Nullable<bool> Enabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If set to true, it is able to accept jobs.
Default: true
Stability: Experimental
JobQueueName
(experimental) A name for the job queue.
public string JobQueueName { get; set; }
Property Value
System.String
Remarks
Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Default: - Cloudformation-generated name
Stability: Experimental
Priority
(experimental) The priority of the job queue.
public Nullable<double> Priority { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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.
Default: 1
Stability: Experimental