AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Deadline::Fleet

CfnFleet

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.

Import

import { CfnFleet } from 'aws-cdk-lib/aws-deadline';

Or use the module namespace:

import * as deadline from 'aws-cdk-lib/aws-deadline';
// deadline.CfnFleet

Properties

Configuration passed to the constructor as CfnFleetProps.

configurationRequired
IResolvable | FleetConfigurationProperty

The configuration details for the fleet.

displayNameRequired
string

The display name of the fleet summary to update. > 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.

farmIdRequired
string

The farm ID.

maxWorkerCountRequired
number

The maximum number of workers specified in the fleet.

roleArnRequired
string

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

descriptionOptional
string

A description that helps identify what the fleet is used for. > 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.

Default: - ""

hostConfigurationOptional
IResolvable | HostConfigurationProperty

Provides a script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. To remove a script from a fleet, use the [UpdateFleet](https://docs.aws.amazon.com/deadline-cloud/latest/APIReference/API_UpdateFleet.html) operation with the `hostConfiguration` `scriptBody` parameter set to an empty string ("").

minWorkerCountOptional
number

The minimum number of workers in the fleet.

Default: - 0

tagsOptional
CfnTag[]

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Deadline::FleetView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-deadline
CFN TypeAWS::Deadline::Fleet
Properties9

Related Constructs

Explore This Service

External Links