CreateJobQueueRequest Class | AWS SDK for .NET V3

Container for the parameters to the CreateJobQueue operation. Creates an Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order that the Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Batch.AmazonBatchRequest
      Amazon.Batch.Model.CreateJobQueueRequest

Namespace: Amazon.Batch.Model
Assembly: AWSSDK.Batch.dll
Version: 3.x.y.z

Syntax

public class CreateJobQueueRequest : AmazonBatchRequest
         IAmazonWebServiceRequest

The CreateJobQueueRequest type exposes the following members

Constructors

	Name	Description
	CreateJobQueueRequest()

Properties

Name	Type	Description
ComputeEnvironmentOrder	System.Collections.Generic.List<Amazon.Batch.Model.ComputeEnvironmentOrder>	Gets and sets the property ComputeEnvironmentOrder. 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. All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.
JobQueueName	System.String	Gets and sets the property JobQueueName. 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 (_).
JobStateTimeLimitActions	System.Collections.Generic.List<Amazon.Batch.Model.JobStateTimeLimitAction>	Gets and sets the property JobStateTimeLimitActions. The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after `maxTimeSeconds` has passed.
Priority	System.Int32	Gets and sets the property Priority. 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`. 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.
SchedulingPolicyArn	System.String	Gets and sets the property SchedulingPolicyArn. The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy. The format is `aws:Partition:batch:Region:Account:scheduling-policy/Name`. An example is `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.
State	Amazon.Batch.JQState	Gets and sets the property State. The state of the job queue. If the job queue state is `ENABLED`, it is able to accept jobs. If the job queue state is `DISABLED`, new jobs can't be added to the queue, but jobs already in the queue can finish.
Tags	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property Tags. The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.

Examples

This example creates a job queue called LowPriority that uses the M4Spot compute environment.

To create a job queue with a single compute environment


var client = new AmazonBatchClient();
var response = client.CreateJobQueue(new CreateJobQueueRequest 
{
    ComputeEnvironmentOrder = new List<ComputeEnvironmentOrder> {
        new ComputeEnvironmentOrder {
            ComputeEnvironment = "M4Spot",
            Order = 1
        }
    },
    JobQueueName = "LowPriority",
    Priority = 1,
    State = "ENABLED"
});

string jobQueueArn = response.JobQueueArn;
string jobQueueName = response.JobQueueName;

This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.

To create a job queue with multiple compute environments


var client = new AmazonBatchClient();
var response = client.CreateJobQueue(new CreateJobQueueRequest 
{
    ComputeEnvironmentOrder = new List<ComputeEnvironmentOrder> {
        new ComputeEnvironmentOrder {
            ComputeEnvironment = "C4OnDemand",
            Order = 1
        },
        new ComputeEnvironmentOrder {
            ComputeEnvironment = "M4Spot",
            Order = 2
        }
    },
    JobQueueName = "HighPriority",
    Priority = 10,
    State = "ENABLED"
});

string jobQueueArn = response.JobQueueArn;
string jobQueueName = response.JobQueueName;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5