AWS::Deadline::Fleet - AWS CloudFormation
SyntaxPropertiesReturn values

AWS::Deadline::Fleet

Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.

Syntax

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

JSON

{
  "Type" : "AWS::Deadline::Fleet",
  "Properties" : {
      "Configuration" : FleetConfiguration,
      "Description" : String,
      "DisplayName" : String,
      "FarmId" : String,
      "MaxWorkerCount" : Integer,
      "MinWorkerCount" : Integer,
      "RoleArn" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Deadline::Fleet
Properties:
  Configuration: 
    FleetConfiguration
  Description: String
  DisplayName: String
  FarmId: String
  MaxWorkerCount: Integer
  MinWorkerCount: Integer
  RoleArn: String
  Tags: 
    - Tag

Properties

Configuration

The configuration details for the fleet.

Required: Yes

Type: FleetConfiguration

Update requires: No interruption

Description

A description that helps identify what the fleet is used for.

Required: No

Type: String

Minimum: 0

Maximum: 100

Update requires: No interruption

DisplayName

The display name of the fleet summary to update.

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

FarmId

The farm ID.

Required: Yes

Type: String

Pattern: ^farm-[0-9a-f]{32}$

Update requires: Replacement

MaxWorkerCount

The maximum number of workers specified in the fleet.

Required: Yes

Type: Integer

Minimum: 0

Maximum: 2147483647

Update requires: No interruption

MinWorkerCount

The minimum number of workers in the fleet.

Required: No

Type: Integer

Minimum: 0

Maximum: 2147483647

Update requires: No interruption

RoleArn

The IAM role that workers in the fleet use when processing jobs.

Required: Yes

Type: String

Pattern: ^arn:(aws[a-zA-Z-]*):iam::\d{12}:role(/[!-.0-~]+)*/[\w+=,.@-]+$

Update requires: No interruption

Tags

The tags to add to your fleet. 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 fleet.

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 fleet.

FleetId

The fleet ID.

Status

The status of the fleet.

WorkerCount

The number of workers in the fleet summary.