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	awscc.deadline.queues

Fields

get (all properties)

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
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

For more information, see AWS::Deadline::Queue.

Methods

Name	Resource	Accessible by	Required Params
create_resource	queues	INSERT	DisplayName, FarmId, region
delete_resource	queues	DELETE	Identifier, region
update_resource	queues	UPDATE	Identifier, PatchDocument, region
list_resources	queues_list_only	SELECT	region
get_resource	queues	SELECT	Identifier, region

SELECT examples

get (all properties)

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,
  tags
FROM awscc.deadline.queues
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all queues in a region.

SELECT
  region,
  arn
FROM awscc.deadline.queues_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.deadline.queues (
  DisplayName,
  FarmId,
  region
)
SELECT
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.deadline.queues (
  AllowedStorageProfileIds,
  DefaultBudgetAction,
  Description,
  DisplayName,
  FarmId,
  JobAttachmentSettings,
  JobRunAsUser,
  RequiredFileSystemLocationNames,
  RoleArn,
  Tags,
  region
)
SELECT
  '{{ allowed_storage_profile_ids }}',
  '{{ default_budget_action }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ job_attachment_settings }}',
  '{{ job_run_as_user }}',
  '{{ required_file_system_location_names }}',
  '{{ role_arn }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: queue
  props:
    - name: allowed_storage_profile_ids
      value:
        - '{{ allowed_storage_profile_ids[0] }}'
    - name: default_budget_action
      value: '{{ default_budget_action }}'
    - name: description
      value: '{{ description }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: farm_id
      value: '{{ farm_id }}'
    - name: job_attachment_settings
      value:
        s3_bucket_name: '{{ s3_bucket_name }}'
        root_prefix: '{{ root_prefix }}'
    - name: job_run_as_user
      value:
        posix:
          user: '{{ user }}'
          group: '{{ group }}'
        windows:
          user: '{{ user }}'
          password_arn: '{{ password_arn }}'
        run_as: '{{ run_as }}'
    - name: required_file_system_location_names
      value:
        - '{{ required_file_system_location_names[0] }}'
    - name: role_arn
      value: '{{ role_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.deadline.queues
SET PatchDocument = string('{{ {
    "AllowedStorageProfileIds": allowed_storage_profile_ids,
    "DefaultBudgetAction": default_budget_action,
    "Description": description,
    "DisplayName": display_name,
    "JobAttachmentSettings": job_attachment_settings,
    "JobRunAsUser": job_run_as_user,
    "RequiredFileSystemLocationNames": required_file_system_location_names,
    "RoleArn": role_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.queues
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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,
deadline:TagResource,
deadline:ListTagsForResource

Read

deadline:GetQueue,
identitystore:ListGroupMembershipsForMember,
deadline:ListTagsForResource

Update

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

Delete

deadline:DeleteQueue,
deadline:GetQueue,
identitystore:ListGroupMembershipsForMember

List

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