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

Inheritance

object

CfnFleet.HostConfigurationProperty

Implements

CfnFleet.IHostConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Deadline

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFleet.HostConfigurationProperty : CfnFleet.IHostConfigurationProperty

Syntax (vb)

Public Class CfnFleet.HostConfigurationProperty Implements CfnFleet.IHostConfigurationProperty

Remarks

To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string ("").

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-hostconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Deadline;

             var hostConfigurationProperty = new HostConfigurationProperty {
                 ScriptBody = "scriptBody",

                 // the properties below are optional
                 ScriptTimeoutSeconds = 123
             };

Synopsis

Constructors

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.

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.
ScriptTimeoutSeconds	The maximum time that the host configuration can run.

Constructors

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.

public HostConfigurationProperty()

Remarks

To remove a script from a fleet, use the UpdateFleet operation with the hostConfiguration scriptBody parameter set to an empty string ("").

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-hostconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Deadline;

             var hostConfigurationProperty = new HostConfigurationProperty {
                 ScriptBody = "scriptBody",

                 // the properties below are optional
                 ScriptTimeoutSeconds = 123
             };

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.

public string ScriptBody { get; set; }

Property Value

string

Remarks

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 ( <code>sudo root</code> on Linux, as an Administrator on Windows).

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-hostconfiguration.html#cfn-deadline-fleet-hostconfiguration-scriptbody

ScriptTimeoutSeconds

The maximum time that the host configuration can run.

public double? ScriptTimeoutSeconds { get; set; }

Property Value

double?

Remarks

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

Default: - 300

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-deadline-fleet-hostconfiguration.html#cfn-deadline-fleet-hostconfiguration-scripttimeoutseconds

Implements

CfnFleet.IHostConfigurationProperty