CfnJobQueueProps

class aws_cdk.aws_batch.CfnJobQueueProps(*, priority, compute_environment_order=None, job_queue_name=None, job_queue_type=None, job_state_time_limit_actions=None, scheduling_policy_arn=None, service_environment_order=None, state=None, tags=None)

Bases: object

Properties for defining a CfnJobQueue.

Parameters:

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

  • compute_environment_order (Union[IResolvable, Sequence[Union[IResolvable, ComputeEnvironmentOrderProperty, Dict[str, Any]]], 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. .. epigraph:: 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.

  • 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 (_).

  • job_queue_type (Optional[str]) – The type of job queue. For service jobs that run on SageMaker AI , this value is SAGEMAKER_TRAINING . For regular container jobs, this value is EKS , ECS , or ECS_FARGATE depending on the compute environment.

  • job_state_time_limit_actions (Union[IResolvable, Sequence[Union[IResolvable, JobStateTimeLimitActionProperty, Dict[str, Any]]], None]) – 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. AWS Batch will perform each action after maxTimeSeconds has passed.

  • scheduling_policy_arn (Optional[str]) – The Amazon Resource Name (ARN) of the scheduling policy. The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .

  • service_environment_order (Union[IResolvable, Sequence[Union[IResolvable, ServiceEnvironmentOrderProperty, Dict[str, Any]]], None]) – The order of the service environment associated with the job queue. Job queues with a higher priority are evaluated first when associated with the same service environment.

  • state (Optional[str]) – 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 (Optional[Mapping[str, str]]) – The tags that are applied to the job queue. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_batch as batch

cfn_job_queue_props = batch.CfnJobQueueProps(
    priority=123,

    # the properties below are optional
    compute_environment_order=[batch.CfnJobQueue.ComputeEnvironmentOrderProperty(
        compute_environment="computeEnvironment",
        order=123
    )],
    job_queue_name="jobQueueName",
    job_queue_type="jobQueueType",
    job_state_time_limit_actions=[batch.CfnJobQueue.JobStateTimeLimitActionProperty(
        action="action",
        max_time_seconds=123,
        reason="reason",
        state="state"
    )],
    scheduling_policy_arn="schedulingPolicyArn",
    service_environment_order=[batch.CfnJobQueue.ServiceEnvironmentOrderProperty(
        order=123,
        service_environment="serviceEnvironment"
    )],
    state="state",
    tags={
        "tags_key": "tags"
    }
)

Attributes

compute_environment_order

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. .. epigraph:

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.
See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-computeenvironmentorder

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuename

job_queue_type

The type of job queue.

For service jobs that run on SageMaker AI , this value is SAGEMAKER_TRAINING . For regular container jobs, this value is EKS , ECS , or ECS_FARGATE depending on the compute environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobqueuetype

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.

AWS Batch will perform each action after maxTimeSeconds has passed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-jobstatetimelimitactions

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-priority

scheduling_policy_arn

The Amazon Resource Name (ARN) of the scheduling policy.

The format is aws: *Partition* :batch: *Region* : *Account* :scheduling-policy/ *Name* . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-schedulingpolicyarn

service_environment_order

The order of the service environment associated with the job queue.

Job queues with a higher priority are evaluated first when associated with the same service environment.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-serviceenvironmentorder

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-state

tags

The tags that are applied to the job queue.

For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-batch-jobqueue.html#cfn-batch-jobqueue-tags