Skip to content

HostConfiguration

Used by
Source code in docs_src/capo_deadline/types/host_configuration.py 
14
15
16
17
18
class HostConfiguration(TypedDict, closed=True):
    script_body: "capo_deadline.types.host_configuration_script.HostConfigurationScript"
    """<p>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 <code>STARTING</code> state and before the worker processes tasks.</p> <p>For more information about using the script, see <a href="https://docs.aws.amazon.com/deadline-cloud/latest/developerguide/smf-admin.html">Run scripts as an administrator to configure workers</a> in the <i>Deadline Cloud Developer Guide</i>. </p> <important> <p>The script runs as an administrative user (<code>sudo root</code> on Linux, as an Administrator on Windows). </p> </important>"""
    script_timeout_seconds: "capo_deadline.types.host_configuration_script_timeout_seconds.HostConfigurationScriptTimeoutSeconds"
    """<p>The maximum time that the host configuration can run. If the timeout expires, the worker enters the <code>NOT RESPONDING</code> state and shuts down. You are charged for the time that the worker is running the host configuration script.</p> <note> <p>You should configure your fleet for a maximum of one worker while testing your host configuration script to avoid starting additional workers.</p> </note> <p>The default is 300 seconds (5 minutes).</p>"""

script_body instance-attribute 

script_body: HostConfigurationScript

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.

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

script_timeout_seconds instance-attribute 

script_timeout_seconds: HostConfigurationScriptTimeoutSeconds

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.

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