interface HostConfigurationProperty

Language	Type name
.NET	`Amazon.CDK.aws_deadline.CfnFleet.HostConfigurationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsdeadline#CfnFleet_HostConfigurationProperty`
Java	`software.amazon.awscdk.services.deadline.CfnFleet.HostConfigurationProperty`
Python	`aws_cdk.aws_deadline.CfnFleet.HostConfigurationProperty`
TypeScript	`aws-cdk-lib` » `aws_deadline` » `CfnFleet` » `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 operation with the hostConfiguration scriptBody parameter set to an empty string ("").

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_deadline as deadline } from 'aws-cdk-lib';
const hostConfigurationProperty: deadline.CfnFleet.HostConfigurationProperty = {
  scriptBody: 'scriptBody',

  // the properties below are optional
  scriptTimeoutSeconds: 123,
};

Properties

Name	Type	Description
scriptBody	`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.
scriptTimeoutSeconds?	`number`	The maximum time that the host configuration can run.

scriptBody

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

scriptTimeoutSeconds?

Type: number (optional, default: 300)

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