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

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.

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

Methods

Name	Accessible by	Required Params
create_resource	INSERT	AmountRequirementName, DisplayName, MaxCount, FarmId, 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 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 data__Identifier = '<FarmId>|<LimitId>';

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 
'{{ AmountRequirementName }}',
 '{{ DisplayName }}',
 '{{ FarmId }}',
 '{{ MaxCount }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: limit
    props:
      - name: AmountRequirementName
        value: '{{ AmountRequirementName }}'
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: FarmId
        value: '{{ FarmId }}'
      - name: MaxCount
        value: '{{ MaxCount }}'

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.limits
WHERE data__Identifier = '<FarmId|LimitId>'
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