CfnJobQueueProps

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

Bases: object

Properties for defining a CfnJobQueue.

Parameters
  • compute_environment_order (Union[IResolvable, Sequence[Union[IResolvable, ComputeEnvironmentOrderProperty, 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. .. 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.

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

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

  • 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:012345678910:scheduling-policy/MySchedulingPolicy .

  • 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 applied to the job queue. For more information, see Tagging your AWS Batch resources in AWS Batch User Guide .

Link

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.
import aws_cdk.aws_batch as batch

cfn_job_queue_props = batch.CfnJobQueueProps(
    compute_environment_order=[batch.CfnJobQueue.ComputeEnvironmentOrderProperty(
        compute_environment="computeEnvironment",
        order=123
    )],
    priority=123,

    # the properties below are optional
    job_queue_name="jobQueueName",
    scheduling_policy_arn="schedulingPolicyArn",
    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.
Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ComputeEnvironmentOrderProperty]]]

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

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Union[int, float]

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:012345678910:scheduling-policy/MySchedulingPolicy .

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

tags

The tags applied to the job queue.

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

Link

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

Return type

Optional[Mapping[str, str]]