JobQueueProps

class aws_cdk.aws_batch.JobQueueProps(*, compute_environments=None, enabled=None, job_queue_name=None, job_state_time_limit_actions=None, priority=None, scheduling_policy=None)

Bases: object

Props to configure a JobQueue.

Parameters:

  • compute_environments (Optional[Sequence[Union[OrderedComputeEnvironment, Dict[str, Any]]]]) – 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. Default: none

  • enabled (Optional[bool]) – 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

  • job_queue_name (Optional[str]) – 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 (_) Default: - no name

  • job_state_time_limit_actions (Optional[Sequence[Union[JobStateTimeLimitAction, Dict[str, Any]]]]) – 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. Default: - no actions

  • priority (Union[int, float, None]) – 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. Default: 1

  • scheduling_policy (Optional[ISchedulingPolicy]) – The SchedulingPolicy for this JobQueue. Instructs the Scheduler how to schedule different jobs. Default: - no scheduling policy

ExampleMetadata:

infused

Example:

# vpc: ec2.IVpc


ecs_job = batch.EcsJobDefinition(self, "JobDefn",
    container=batch.EcsEc2ContainerDefinition(self, "containerDefn",
        image=ecs.ContainerImage.from_registry("public.ecr.aws/amazonlinux/amazonlinux:latest"),
        memory=cdk.Size.mebibytes(2048),
        cpu=256
    )
)

queue = batch.JobQueue(self, "JobQueue",
    compute_environments=[batch.OrderedComputeEnvironment(
        compute_environment=batch.ManagedEc2EcsComputeEnvironment(self, "managedEc2CE",
            vpc=vpc
        ),
        order=1
    )],
    priority=10
)

user = iam.User(self, "MyUser")
ecs_job.grant_submit_job(user, queue)

Attributes

compute_environments

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.

Default:

none

enabled

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

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

Default:

  • no name

job_state_time_limit_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.

Default:

  • no actions

priority

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.

Default:

1

scheduling_policy

The SchedulingPolicy for this JobQueue.

Instructs the Scheduler how to schedule different jobs.

Default:

  • no scheduling policy