farms

Creates, updates, deletes, gets or lists a farms resource.

Overview

Name	farms
Type	Resource
Id	aws.deadline.farms

Fields

The following fields are returned by SELECT queries:

get_farm

Name	Datatype	Description
cost_scale_factor	number (float)	A multiplier applied to the farm's calculated costs for usage data and budget tracking. A value less than 1 represents a discount, a value greater than 1 represents a premium, and a value of 1 represents no adjustment.
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
description	string	The description of the farm. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
display_name	string	The display name of the farm. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
farm_id	string	The farm ID of the farm to get. (pattern: <code>farm-[0-9a-f]{32}</code>)
kms_key_arn	string	The ARN of the KMS key used on the farm. (pattern: <code>arn:(aws[a-zA-Z-]*):kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:key/[\w-]{1,120}</code>)
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

list_farms

Name	Datatype	Description
created_at	string (date-time)	The date and time the resource was created.
created_by	string	The user or system that created this resource.
display_name	string	The display name of the farm. This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.
farm_id	string	The farm ID. (pattern: <code>farm-[0-9a-f]{32}</code>)
kms_key_arn	string	The ARN for the KMS key. (pattern: <code>arn:(aws[a-zA-Z-]*):kms:[a-z]{2}((-gov)|(-iso(b?)))?-[a-z]+-\d{1}:\d{12}:key/[\w-]{1,120}</code>)
updated_at	string (date-time)	The date and time the resource was updated.
updated_by	string	The user or system that updated this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_farm	select	farm_id, region		Get a farm.
list_farms	select	region	nextToken, maxResults, principalId	Lists farms.
create_farm	insert	region, displayName	X-Amz-Client-Token	Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.
associate_member_to_farm	update	farm_id, principal_id, region, principalType, identityStoreId, membershipLevel		Assigns a farm membership level to a member.
disassociate_member_from_farm	update	farm_id, principal_id, region		Disassociates a member from a farm.
update_farm	update	farm_id, region		Updates a farm.
delete_farm	delete	farm_id, region		Deletes a farm.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
farm_id	string	The farm ID of the farm to delete.
principal_id	string	A member's principal ID to disassociate from a farm.
region	string	AWS region (default: us-east-1)
X-Amz-Client-Token	string	The unique token which the server uses to recognize retries of the same request.
maxResults	integer	The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
nextToken	string	The token for the next set of results, or null to start from the beginning.
principalId	string	The principal ID of the member to list on the farm.

SELECT examples

get_farm

Get a farm.

SELECT
cost_scale_factor,
created_at,
created_by,
description,
display_name,
farm_id,
kms_key_arn,
updated_at,
updated_by
FROM aws.deadline.farms
WHERE farm_id = '{{ farm_id }}' -- required
AND region = '{{ region }}' -- required
;

list_farms

Lists farms.

SELECT
created_at,
created_by,
display_name,
farm_id,
kms_key_arn,
updated_at,
updated_by
FROM aws.deadline.farms
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND principalId = '{{ principalId }}'
;

INSERT examples

create_farm

Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.

INSERT INTO aws.deadline.farms (
displayName,
description,
kmsKeyArn,
costScaleFactor,
tags,
region,
`X-Amz-Client-Token`
)
SELECT 
'{{ displayName }}' /* required */,
'{{ description }}',
'{{ kmsKeyArn }}',
{{ costScaleFactor }},
'{{ tags }}',
'{{ region }}',
'{{ X-Amz-Client-Token }}'
RETURNING
farm_id
;

Manifest

# Description fields are for documentation purposes
- name: farms
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the farms resource.
  - name: displayName
    value: "{{ displayName }}"
  - name: description
    value: "{{ description }}"
  - name: kmsKeyArn
    value: "{{ kmsKeyArn }}"
  - name: costScaleFactor
    value: {{ costScaleFactor }}
  - name: tags
    value: "{{ tags }}"
  - name: X-Amz-Client-Token
    value: "{{ X-Amz-Client-Token }}"
    description: The unique token which the server uses to recognize retries of the same request.
    description: The unique token which the server uses to recognize retries of the same request.

UPDATE examples

associate_member_to_farm

Assigns a farm membership level to a member.

UPDATE aws.deadline.farms
SET 
principalType = '{{ principalType }}',
identityStoreId = '{{ identityStoreId }}',
membershipLevel = '{{ membershipLevel }}',
identityCenterRegion = '{{ identityCenterRegion }}'
WHERE 
farm_id = '{{ farm_id }}' --required
AND principal_id = '{{ principal_id }}' --required
AND region = '{{ region }}' --required
AND principalType = '{{ principalType }}' --required
AND identityStoreId = '{{ identityStoreId }}' --required
AND membershipLevel = '{{ membershipLevel }}' --required;

disassociate_member_from_farm

Disassociates a member from a farm.

UPDATE aws.deadline.farms
SET 
-- No updatable properties
WHERE 
farm_id = '{{ farm_id }}' --required
AND principal_id = '{{ principal_id }}' --required
AND region = '{{ region }}' --required;

update_farm

Updates a farm.

UPDATE aws.deadline.farms
SET 
displayName = '{{ displayName }}',
description = '{{ description }}',
costScaleFactor = {{ costScaleFactor }}
WHERE 
farm_id = '{{ farm_id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_farm

Deletes a farm.

DELETE FROM aws.deadline.farms
WHERE farm_id = '{{ farm_id }}' --required
AND region = '{{ region }}' --required
;