interface JobQueueProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Batch.JobQueueProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsbatch#JobQueueProps |
![]() | software.amazon.awscdk.services.batch.JobQueueProps |
![]() | aws_cdk.aws_batch.JobQueueProps |
![]() | aws-cdk-lib » aws_batch » JobQueueProps |
Props to configure a JobQueue.
Example
declare const vpc: ec2.IVpc;
const ecsJob = new batch.EcsJobDefinition(this, 'JobDefn', {
container: new batch.EcsEc2ContainerDefinition(this, 'containerDefn', {
image: ecs.ContainerImage.fromRegistry('public.ecr.aws/amazonlinux/amazonlinux:latest'),
memory: cdk.Size.mebibytes(2048),
cpu: 256,
}),
});
const queue = new batch.JobQueue(this, 'JobQueue', {
computeEnvironments: [{
computeEnvironment: new batch.ManagedEc2EcsComputeEnvironment(this, 'managedEc2CE', {
vpc,
}),
order: 1,
}],
priority: 10,
});
const user = new iam.User(this, 'MyUser');
ecsJob.grantSubmitJob(user, queue);
Properties
Name | Type | Description |
---|---|---|
compute | Ordered [] | The set of compute environments mapped to a job queue and their order relative to each other. |
enabled? | boolean | If the job queue is enabled, it is able to accept jobs. |
job | string | The name of the job queue. |
job | Job [] | The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. |
priority? | number | The priority of the job queue. |
scheduling | IScheduling | The SchedulingPolicy for this JobQueue. |
computeEnvironments?
Type:
Ordered
[]
(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 (_)
jobStateTimeLimitActions?
Type:
Job
[]
(optional, default: no actions)
The set of actions that AWS Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times.
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:
IScheduling
(optional, default: no scheduling policy)
The SchedulingPolicy for this JobQueue.
Instructs the Scheduler how to schedule different jobs.