queues

Creates, updates, deletes or gets a queue resource or lists queues in a region

Overview

Name	queues
Type	Resource
Description	Definition of AWS::Deadline::Queue Resource Type
Id	aws.deadline.queues

Fields

Name	Datatype	Description
allowed_storage_profile_ids	array
default_budget_action	string
description	string
display_name	string
farm_id	string
job_attachment_settings	object
job_run_as_user	object
queue_id	string
required_file_system_location_names	array
role_arn	string
arn	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DisplayName, 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 queues in a region.

SELECT
region,
allowed_storage_profile_ids,
default_budget_action,
description,
display_name,
farm_id,
job_attachment_settings,
job_run_as_user,
queue_id,
required_file_system_location_names,
role_arn,
arn
FROM aws.deadline.queues
WHERE region = 'us-east-1';

Gets all properties from an individual queue.

SELECT
region,
allowed_storage_profile_ids,
default_budget_action,
description,
display_name,
farm_id,
job_attachment_settings,
job_run_as_user,
queue_id,
required_file_system_location_names,
role_arn,
arn
FROM aws.deadline.queues
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.deadline.queues (
 DisplayName,
 region
)
SELECT 
'{{ DisplayName }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.deadline.queues (
 AllowedStorageProfileIds,
 DefaultBudgetAction,
 Description,
 DisplayName,
 FarmId,
 JobAttachmentSettings,
 JobRunAsUser,
 RequiredFileSystemLocationNames,
 RoleArn,
 region
)
SELECT 
 '{{ AllowedStorageProfileIds }}',
 '{{ DefaultBudgetAction }}',
 '{{ Description }}',
 '{{ DisplayName }}',
 '{{ FarmId }}',
 '{{ JobAttachmentSettings }}',
 '{{ JobRunAsUser }}',
 '{{ RequiredFileSystemLocationNames }}',
 '{{ RoleArn }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: queue
    props:
      - name: AllowedStorageProfileIds
        value:
          - '{{ AllowedStorageProfileIds[0] }}'
      - name: DefaultBudgetAction
        value: '{{ DefaultBudgetAction }}'
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: FarmId
        value: '{{ FarmId }}'
      - name: JobAttachmentSettings
        value:
          S3BucketName: '{{ S3BucketName }}'
          RootPrefix: '{{ RootPrefix }}'
      - name: JobRunAsUser
        value:
          Posix:
            User: '{{ User }}'
            Group: '{{ Group }}'
          Windows:
            User: '{{ User }}'
            PasswordArn: '{{ PasswordArn }}'
          RunAs: '{{ RunAs }}'
      - name: RequiredFileSystemLocationNames
        value:
          - '{{ RequiredFileSystemLocationNames[0] }}'
      - name: RoleArn
        value: '{{ RoleArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.deadline.queues
WHERE data__Identifier = '<Arn>'
AND region = 'us-east-1';

Permissions

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

Create

deadline:CreateQueue,
deadline:GetQueue,
iam:PassRole,
identitystore:ListGroupMembershipsForMember,
logs:CreateLogGroup,
s3:ListBucket

Read

deadline:GetQueue,
identitystore:ListGroupMembershipsForMember

Update

deadline:UpdateQueue,
deadline:GetQueue,
iam:PassRole,
identitystore:ListGroupMembershipsForMember,
logs:CreateLogGroup,
s3:ListBucket

Delete

deadline:DeleteQueue,
deadline:GetQueue,
identitystore:ListGroupMembershipsForMember

List

deadline:ListQueues,
identitystore:DescribeGroup,
identitystore:DescribeUser,
identitystore:ListGroupMembershipsForMember