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

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
farm_id	string
queue_environment_id	string
queue_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	queue_environments	INSERT	FarmId, QueueId, Priority, Template, TemplateType, region
delete_resource	queue_environments	DELETE	Identifier, region
update_resource	queue_environments	UPDATE	Identifier, PatchDocument, region
list_resources	queue_environments_list_only	SELECT	region
get_resource	queue_environments	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual queue_environment.

SELECT
  region,
  farm_id,
  name,
  priority,
  queue_environment_id,
  queue_id,
  template,
  template_type
FROM awscc.deadline.queue_environments
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ farm_id }}|{{ queue_id }}|{{ queue_environment_id }}';

list (identifiers only)

Lists all queue_environments in a region.

SELECT
  region,
  farm_id,
  queue_id,
  queue_environment_id
FROM awscc.deadline.queue_environments_list_only
WHERE
  region = '{{ region }}';

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 awscc.deadline.queue_environments (
  FarmId,
  Priority,
  QueueId,
  Template,
  TemplateType,
  region
)
SELECT
  '{{ farm_id }}',
  '{{ priority }}',
  '{{ queue_id }}',
  '{{ template }}',
  '{{ template_type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.deadline.queue_environments (
  FarmId,
  Priority,
  QueueId,
  Template,
  TemplateType,
  region
)
SELECT
  '{{ farm_id }}',
  '{{ priority }}',
  '{{ queue_id }}',
  '{{ template }}',
  '{{ template_type }}',
  '{{ 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_environment
  props:
    - name: farm_id
      value: '{{ farm_id }}'
    - name: priority
      value: '{{ priority }}'
    - name: queue_id
      value: '{{ queue_id }}'
    - name: template
      value: '{{ template }}'
    - name: template_type
      value: '{{ template_type }}'

UPDATE example

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

/*+ update */
UPDATE awscc.deadline.queue_environments
SET PatchDocument = string('{{ {
    "Priority": priority,
    "Template": template,
    "TemplateType": template_type
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ farm_id }}|{{ queue_id }}|{{ queue_environment_id }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.queue_environments
WHERE
  Identifier = '{{ farm_id }}|{{ queue_id }}|{{ queue_environment_id }}' 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 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