AWS::Deadline::Farm - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Deadline::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.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Deadline::Farm",
  "Properties" : {
      "Description" : String,
      "DisplayName" : String,
      "KmsKeyArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Deadline::Farm
Properties:
  Description: String
  DisplayName: String
  KmsKeyArn: String
  Tags: 
    - Tag

Properties

Description

A description of the farm that helps identify what the farm is used for.

Required: No

Type: String

Minimum: 0

Maximum: 100

Update requires: No interruption

DisplayName

The display name of the farm.

Important

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.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Update requires: No interruption

KmsKeyArn

The ARN for the KMS key.

Required: No

Type: String

Pattern: ^arn:aws[-a-z]*:kms:.*:key/.*

Update requires: Replacement

Tags

The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the farm.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) assigned to the farm.

FarmId

The farm ID.