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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-batch/types.rb

Overview

Contains the parameters for ‘CreateJobQueue`.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

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 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 markdown=“1”> All compute environments that are associated with a job queue must share the same architecture. Batch doesn’t support mixing compute environment architecture types in a single job queue.

</note>

Returns:



2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/aws-sdk-batch/types.rb', line 2336

class CreateJobQueueRequest < Struct.new(
  :job_queue_name,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#job_queue_name ⇒ String

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

Returns:

  • (String) 


2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/aws-sdk-batch/types.rb', line 2336

class CreateJobQueueRequest < Struct.new(
  :job_queue_name,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#job_state_time_limit_actions ⇒ Array<Types::JobStateTimeLimitAction>

The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after ‘maxTimeSeconds` has passed.

Returns:



2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/aws-sdk-batch/types.rb', line 2336

class CreateJobQueueRequest < Struct.new(
  :job_queue_name,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#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`. 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.

Returns:

  • (Integer) 


2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/aws-sdk-batch/types.rb', line 2336

class CreateJobQueueRequest < Struct.new(
  :job_queue_name,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_policy_arn ⇒ String

The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair share scheduling policy. If this parameter isn’t specified, the job queue uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can replace but can’t remove the fair share scheduling policy. The format is ‘aws:Partition:batch:Region:Account:scheduling-policy/Name `. An example is `aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy`.

Returns:

  • (String) 


2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/aws-sdk-batch/types.rb', line 2336

class CreateJobQueueRequest < Struct.new(
  :job_queue_name,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/aws-sdk-batch/types.rb', line 2336

class CreateJobQueueRequest < Struct.new(
  :job_queue_name,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end

#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 your Batch resources] in *Batch User Guide*.

[1]: docs.aws.amazon.com/batch/latest/userguide/using-tags.html

Returns:

  • (Hash<String,String>) 


2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
 
# File 'lib/aws-sdk-batch/types.rb', line 2336

class CreateJobQueueRequest < Struct.new(
  :job_queue_name,
  :state,
  :scheduling_policy_arn,
  :priority,
  :compute_environment_order,
  :tags,
  :job_state_time_limit_actions)
  SENSITIVE = []
  include Aws::Structure
end