Package software.amazon.awscdk.services.deadline

Interface CfnFleet.HostConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.HostConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFleet

@Stability(Stable)
public static interface CfnFleet.HostConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.deadline.*;
 HostConfigurationProperty hostConfigurationProperty = HostConfigurationProperty.builder()
         .scriptBody("scriptBody")
         // the properties below are optional
         .scriptTimeoutSeconds(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFleet.HostConfigurationProperty.Builder	A builder for CfnFleet.HostConfigurationProperty
static final class	CfnFleet.HostConfigurationProperty.Jsii$Proxy	An implementation for CfnFleet.HostConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnFleet.HostConfigurationProperty.Builder	builder()
String	getScriptBody()	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.
default Number	getScriptTimeoutSeconds()	The maximum time that the host configuration can run.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getScriptBody

@Stability(Stable)
@NotNull
String getScriptBody()

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

See Also:

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

getScriptTimeoutSeconds

@Stability(Stable)
@Nullable
default Number getScriptTimeoutSeconds()

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

Default: - 300

See Also:

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

builder

@Stability(Stable)
static CfnFleet.HostConfigurationProperty.Builder builder()

Returns:

a CfnFleet.HostConfigurationProperty.Builder of CfnFleet.HostConfigurationProperty