AWS::Deadline::Fleet HostConfiguration - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Deadline::Fleet HostConfiguration

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 operation with the hostConfigurationscriptBody parameter set to an empty string ("").

Syntax

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

JSON

{
  "ScriptBody" : String,
  "ScriptTimeoutSeconds" : Integer
}

YAML

  ScriptBody: String
  ScriptTimeoutSeconds: Integer

Properties

ScriptBody

The text of the script that runs as a worker is starting up that you can use to provide additional configuration for workers in your fleet. The script runs after a worker enters the STARTING state and before the worker processes tasks.

For more information about using the script, see Run scripts as an administrator to configure workers in the Deadline Cloud Developer Guide.

Important

The script runs as an administrative user (sudo root on Linux, as an Administrator on Windows).

Required: Yes

Type: String

Minimum: 0

Maximum: 15000

Update requires: No interruption

ScriptTimeoutSeconds

The maximum time that the host configuration can run. If the timeout expires, the worker enters the NOT RESPONDING state and shuts down. You are charged for the time that the worker is running the host configuration script.

Note

You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.

The default is 300 seconds (5 minutes).

Required: No

Type: Integer

Minimum: 300

Maximum: 3600

Update requires: No interruption