limits

Creates, updates, deletes or gets a limit resource or lists limits in a region

Overview

Name	limits
Type	Resource
Description	Definition of AWS::Deadline::Limit Resource Type
Id	awscc.deadline.limits

Fields

get (all properties)

Name	Datatype	Description
amount_requirement_name	string
current_count	integer
description	string
display_name	string
farm_id	string
limit_id	string
max_count	integer
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
farm_id	string
limit_id	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	limits	INSERT	AmountRequirementName, DisplayName, MaxCount, FarmId, region
delete_resource	limits	DELETE	Identifier, region
update_resource	limits	UPDATE	Identifier, PatchDocument, region
list_resources	limits_list_only	SELECT	region
get_resource	limits	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual limit.

SELECT
  region,
  amount_requirement_name,
  current_count,
  description,
  display_name,
  farm_id,
  limit_id,
  max_count
FROM awscc.deadline.limits
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ farm_id }}|{{ limit_id }}';

list (identifiers only)

Lists all limits in a region.

SELECT
  region,
  farm_id,
  limit_id
FROM awscc.deadline.limits_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.deadline.limits (
  AmountRequirementName,
  DisplayName,
  FarmId,
  MaxCount,
  region
)
SELECT
  '{{ amount_requirement_name }}',
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ max_count }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.deadline.limits (
  AmountRequirementName,
  Description,
  DisplayName,
  FarmId,
  MaxCount,
  region
)
SELECT
  '{{ amount_requirement_name }}',
  '{{ description }}',
  '{{ display_name }}',
  '{{ farm_id }}',
  '{{ max_count }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: limit
    props:
      - name: amount_requirement_name
        value: '{{ amount_requirement_name }}'
      - name: description
        value: '{{ description }}'
      - name: display_name
        value: '{{ display_name }}'
      - name: farm_id
        value: '{{ farm_id }}'
      - name: max_count
        value: '{{ max_count }}'

UPDATE example

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

/*+ update */
UPDATE awscc.deadline.limits
SET PatchDocument = string('{{ {
    "Description": description,
    "DisplayName": display_name,
    "MaxCount": max_count
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ farm_id }}|{{ limit_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.limits
WHERE
  Identifier = '{{ farm_id }}|{{ limit_id }}' AND
  region = 'us-east-1';

Permissions

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

Create

deadline:CreateLimit,
deadline:GetLimit,
kms:Encrypt,
identitystore:ListGroupMembershipsForMember

Read

deadline:GetLimit,
kms:Decrypt,
identitystore:ListGroupMembershipsForMember

Update

deadline:UpdateLimit,
deadline:GetLimit,
kms:Encrypt,
identitystore:ListGroupMembershipsForMember

Delete

deadline:DeleteLimit,
deadline:GetLimit,
kms:Decrypt,
identitystore:ListGroupMembershipsForMember

List

deadline:ListLimits,
identitystore:ListGroupMembershipsForMember