Class: Aws::Deadline::Types::HostConfiguration

Inherits:

Struct

Object
Struct
Aws::Deadline::Types::HostConfiguration

show all

Defined in:: gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb

Overview

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 hostConfiguration scriptBody parameter set to an empty string ("").

Constant Summary collapse

SENSITIVE =

[:script_body]

Instance Attribute Summary collapse

#script_body ⇒ String
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.
#script_timeout_seconds ⇒ Integer
The maximum time that the host configuration can run.

Instance Attribute Details

#script_body ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-deadline/lib/aws-sdk-deadline/types.rb', line 4730

class HostConfiguration < Struct.new(
  :script_body,
  :script_timeout_seconds)
  SENSITIVE = [:script_body]
  include Aws::Structure
end

#script_timeout_seconds ⇒ `Integer`

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