queue_environments

Creates, updates, deletes or gets a queue_environment resource or lists queue_environments in a region

Overview

Name	queue_environments
Type	Resource
Description	Definition of AWS::Deadline::QueueEnvironment Resource Type
Id	aws.deadline.queue_environments

Fields

Name	Datatype	Description
farm_id	string
name	string
priority	integer
queue_environment_id	string
queue_id	string
template	string
template_type	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	FarmId, QueueId, Priority, Template, TemplateType, 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 queue_environments in a region.

SELECT
region,
farm_id,
name,
priority,
queue_environment_id,
queue_id,
template,
template_type
FROM aws.deadline.queue_environments
WHERE region = 'us-east-1';

Gets all properties from an individual queue_environment.

SELECT
region,
farm_id,
name,
priority,
queue_environment_id,
queue_id,
template,
template_type
FROM aws.deadline.queue_environments
WHERE region = 'us-east-1' AND data__Identifier = '<FarmId>|<QueueId>|<QueueEnvironmentId>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.deadline.queue_environments (
 FarmId,
 Priority,
 QueueId,
 Template,
 TemplateType,
 region
)
SELECT 
'{{ FarmId }}',
 '{{ Priority }}',
 '{{ QueueId }}',
 '{{ Template }}',
 '{{ TemplateType }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.deadline.queue_environments (
 FarmId,
 Priority,
 QueueId,
 Template,
 TemplateType,
 region
)
SELECT 
 '{{ FarmId }}',
 '{{ Priority }}',
 '{{ QueueId }}',
 '{{ Template }}',
 '{{ TemplateType }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: queue_environment
    props:
      - name: FarmId
        value: '{{ FarmId }}'
      - name: Priority
        value: '{{ Priority }}'
      - name: QueueId
        value: '{{ QueueId }}'
      - name: Template
        value: '{{ Template }}'
      - name: TemplateType
        value: '{{ TemplateType }}'

DELETE example

/*+ delete */
DELETE FROM aws.deadline.queue_environments
WHERE data__Identifier = '<FarmId|QueueId|QueueEnvironmentId>'
AND region = 'us-east-1';

Permissions

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

Create

deadline:CreateQueueEnvironment,
identitystore:ListGroupMembershipsForMember

Read

deadline:GetQueueEnvironment,
identitystore:ListGroupMembershipsForMember

Update

deadline:UpdateQueueEnvironment,
identitystore:ListGroupMembershipsForMember

Delete

deadline:DeleteQueueEnvironment,
deadline:GetQueueEnvironment,
identitystore:ListGroupMembershipsForMember

List

deadline:ListQueueEnvironments,
identitystore:ListGroupMembershipsForMember