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.

CfnFarm

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.

displayName

costScaleFactor

A description of the farm that helps identify what the farm 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.

description

kmsKeyArn

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.

CfnFleet

configuration

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.

farmId

The maximum number of workers specified in the fleet.

maxWorkerCount

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

roleArn

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.

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 ("").

hostConfiguration

The minimum number of workers in the fleet.

minWorkerCount

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.

Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.

CfnLicenseEndpoint

The identifier of the Amazon EC2 security group that controls access to the license endpoint.

securityGroupIds

Identifies the VPC subnets that can connect to a license endpoint.

subnetIds

The VPC (virtual private cloud) ID associated with the license endpoint.

vpcId

The tags to add to your license endpoint.

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.

Creates a limit that manages the distribution of shared resources, such as floating licenses.

A limit can throttle work assignments, help manage workloads, and track current usage. Before you use a limit, you must associate the limit with one or more queues.

You must add the `amountRequirementName` to a step in a job template to declare the limit requirement.

CfnLimit

The value that you specify as the `name` in the `amounts` field of the `hostRequirements` in a step of a job template to declare the limit requirement.

amountRequirementName

The name of the limit used in lists to identify the limit.

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

The unique identifier of the farm that contains the limit.

The maximum number of resources constrained by this limit.

When all of the resources are in use, steps that require the limit won't be scheduled until the resource is available.

The `maxValue` must not be 0. If the value is -1, there is no restriction on the number of resources that can be acquired for this limit.

maxCount

A description of the limit. A clear description helps you identify the purpose of the limit.

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

CfnMeteredProduct

The Amazon EC2 identifier of the license endpoint.

licenseEndpointId

productId

Creates an AWS Deadline Cloud monitor that you can use to view your farms, queues, and fleets.

After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.

CfnMonitor

The name of the monitor that displays on the Deadline Cloud console.

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

The Amazon Resource Name of the IAM Identity Center instance responsible for authenticating monitor users.

identityCenterInstanceArn

The Amazon Resource Name of the IAM role for the monitor.

Users of the monitor use this role to access Deadline Cloud resources.

The subdomain used for the monitor URL.

The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

subdomain

An array of key-value pairs to apply to this resource.

Creates a queue to coordinate the order in which jobs run on a farm.

A queue can also specify where to pull resources and indicate where to output completed jobs.

CfnQueue

The display name of the queue 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.

The identifiers of the storage profiles that this queue can use to share assets between workers using different operating systems.

allowedStorageProfileIds

The default action taken on a queue summary if a budget wasn't configured.

defaultBudgetAction

A description of the queue that helps identify what the queue 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.

The job attachment settings.

These are the Amazon S3 bucket name and the Amazon S3 prefix.

jobAttachmentSettings

jobRunAsUser

The file system location that the queue uses.

requiredFileSystemLocationNames

The Amazon Resource Name (ARN) of the IAM role that workers use when running jobs in this queue.

The tags to add to your queue.

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.

Creates an environment for a queue that defines how jobs in the queue run.

CfnQueueEnvironment

The identifier assigned to the farm that contains the queue.

priority

The unique identifier of the queue that contains the environment.

queueId

A JSON or YAML template that describes the processing environment for the queue.

template

Specifies whether the template for the queue environment is JSON or YAML.

templateType

Creates an association between a queue and a fleet.

CfnQueueFleetAssociation

The identifier of the farm that contains the queue and the fleet.

fleetId

Associates a limit with a particular queue.

After the limit is associated, all workers for jobs that specify the limit associated with the queue are subject to the limit. You can't associate two limits with the same `amountRequirementName` to the same queue.

CfnQueueLimitAssociation

The unique identifier of the farm that contains the queue-limit association.

The unique identifier of the limit in the association.

limitId

The unique identifier of the queue in the association.

Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.

CfnStorageProfile

The display name of the storage profile 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.

The unique identifier of the farm that contains the storage profile.

osFamily

Operating system specific file system path to the storage location.

AWS deadline

L1 Constructs11