farms

Creates, updates, deletes or gets a farm resource or lists farms in a region

Overview

Name	farms
Type	Resource
Description	Definition of AWS::Deadline::Farm Resource Type
Id	aws.deadline.farms

Fields

Name	Datatype	Description
description	string
display_name	string
farm_id	string
kms_key_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 farms in a region.

SELECT
region,
description,
display_name,
farm_id,
kms_key_arn,
arn
FROM aws.deadline.farms
WHERE region = 'us-east-1';

Gets all properties from an individual farm.

SELECT
region,
description,
display_name,
farm_id,
kms_key_arn,
arn
FROM aws.deadline.farms
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: farm
    props:
      - name: Description
        value: '{{ Description }}'
      - name: DisplayName
        value: '{{ DisplayName }}'
      - name: KmsKeyArn
        value: '{{ KmsKeyArn }}'

DELETE example

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

Permissions

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

Create

deadline:CreateFarm,
deadline:GetFarm,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:GenerateDataKey

Read

deadline:GetFarm,
identitystore:ListGroupMembershipsForMember,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:GenerateDataKey

Update

deadline:UpdateFarm,
deadline:GetFarm,
identitystore:ListGroupMembershipsForMember,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:GenerateDataKey

Delete

deadline:DeleteFarm,
deadline:GetFarm,
identitystore:ListGroupMembershipsForMember,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:GenerateDataKey

List

deadline:ListFarms,
identitystore:ListGroupMembershipsForMember