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

Fields

get (all properties)

Name	Datatype	Description
description	string
display_name	string
farm_id	string
kms_key_arn	string
arn	string
▶tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	farms	INSERT	DisplayName, region
delete_resource	farms	DELETE	Identifier, region
update_resource	farms	UPDATE	Identifier, PatchDocument, region
list_resources	farms_list_only	SELECT	region
get_resource	farms	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual farm.

SELECT
  region,
  description,
  display_name,
  farm_id,
  kms_key_arn,
  arn,
  tags
FROM awscc.deadline.farms
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all farms in a region.

SELECT
  region,
  arn
FROM awscc.deadline.farms_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.deadline.farms (
  DisplayName,
  region
)
SELECT
  '{{ display_name }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.deadline.farms (
  Description,
  DisplayName,
  KmsKeyArn,
  Tags,
  region
)
SELECT
  '{{ description }}',
  '{{ display_name }}',
  '{{ kms_key_arn }}',
  '{{ tags }}',
  '{{ 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: farm
  props:
    - name: description
      value: '{{ description }}'
    - name: display_name
      value: '{{ display_name }}'
    - name: kms_key_arn
      value: '{{ kms_key_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.deadline.farms
SET PatchDocument = string('{{ {
    "Description": description,
    "DisplayName": display_name,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.deadline.farms
WHERE
  Identifier = '{{ arn }}' 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 farms resource, the following permissions are required:

Create

deadline:CreateFarm,
deadline:GetFarm,
deadline:TagResource,
deadline:ListTagsForResource,
identitystore:ListGroupMembershipsForMember,
kms:Encrypt,
kms:Decrypt,
kms:CreateGrant,
kms:GenerateDataKey

Read

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

Update

deadline:UpdateFarm,
deadline:GetFarm,
deadline:TagResource,
deadline:UntagResource,
deadline:ListTagsForResource,
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