You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Batch::Types::CreateJobQueueRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateJobQueueRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  job_queue_name: "String", # required
  state: "ENABLED", # accepts ENABLED, DISABLED
  priority: 1, # required
  compute_environment_order: [ # required
    {
      order: 1, # required
      compute_environment: "String", # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#compute_environment_order ⇒ Array<Types::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 should execute a given 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.

Returns:

#job_queue_name ⇒ String

The name of the job queue.

Returns:

  • (String) —

    The name of the job queue.

#priority ⇒ Integer

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.

Returns:

  • (Integer) —

    The priority of the job queue.

#state ⇒ String

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 cannot be added to the queue, but jobs already in the queue can finish.

Possible values:

  • ENABLED
  • DISABLED

Returns:

  • (String) —

    The state of the job queue.

#tags ⇒ Hash<String,String>

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 AWS Resources in AWS General Reference.

Returns:

  • (Hash<String,String>) —

    The tags that you apply to the job queue to help you categorize and organize your resources.