job_queues

Creates, updates, deletes or gets a job_queue resource or lists job_queues in a region

Overview

Name	job_queues
Type	Resource
Description	Resource Type definition for AWS::Batch::JobQueue
Id	aws.batch.job_queues

Fields

Name	Datatype	Description
job_queue_name	string
job_queue_arn	string	ARN of the Scheduling Policy.
compute_environment_order	array
job_state_time_limit_actions	array
priority	integer
state	string
scheduling_policy_arn	string	ARN of the Scheduling Policy.
tags	object	A key-value pair to associate with a resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ComputeEnvironmentOrder, Priority, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all job_queues in a region.

SELECT
region,
job_queue_name,
job_queue_arn,
compute_environment_order,
job_state_time_limit_actions,
priority,
state,
scheduling_policy_arn,
tags
FROM aws.batch.job_queues
WHERE region = 'us-east-1';

Gets all properties from an individual job_queue.

SELECT
region,
job_queue_name,
job_queue_arn,
compute_environment_order,
job_state_time_limit_actions,
priority,
state,
scheduling_policy_arn,
tags
FROM aws.batch.job_queues
WHERE region = 'us-east-1' AND data__Identifier = '<JobQueueArn>';

INSERT example

Use the following StackQL query and manifest file to create a new job_queue resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.batch.job_queues (
 ComputeEnvironmentOrder,
 Priority,
 region
)
SELECT 
'{{ ComputeEnvironmentOrder }}',
 '{{ Priority }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.batch.job_queues (
 JobQueueName,
 ComputeEnvironmentOrder,
 JobStateTimeLimitActions,
 Priority,
 State,
 SchedulingPolicyArn,
 Tags,
 region
)
SELECT 
 '{{ JobQueueName }}',
 '{{ ComputeEnvironmentOrder }}',
 '{{ JobStateTimeLimitActions }}',
 '{{ Priority }}',
 '{{ State }}',
 '{{ SchedulingPolicyArn }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: job_queue
    props:
      - name: JobQueueName
        value: '{{ JobQueueName }}'
      - name: ComputeEnvironmentOrder
        value:
          - ComputeEnvironment: '{{ ComputeEnvironment }}'
            Order: '{{ Order }}'
      - name: JobStateTimeLimitActions
        value:
          - Action: '{{ Action }}'
            MaxTimeSeconds: '{{ MaxTimeSeconds }}'
            Reason: '{{ Reason }}'
            State: '{{ State }}'
      - name: Priority
        value: '{{ Priority }}'
      - name: State
        value: '{{ State }}'
      - name: SchedulingPolicyArn
        value: '{{ SchedulingPolicyArn }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.batch.job_queues
WHERE data__Identifier = '<JobQueueArn>'
AND region = 'us-east-1';

Permissions

To operate on the job_queues resource, the following permissions are required:

Create

Batch:CreateJobQueue,
Batch:TagResource,
Batch:DescribeJobQueues

Read

Batch:DescribeJobQueues

Update

Batch:DescribeJobQueues,
Batch:UpdateJobQueue,
Batch:TagResource,
Batch:UnTagResource

Delete

Batch:UpdateJobQueue,
Batch:DescribeJobQueues,
Batch:DeleteJobQueue

List

Batch:DescribeJobQueues