Class HostConfiguration

java.lang.Object
software.amazon.awssdk.services.deadline.model.HostConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HostConfiguration.Builder,HostConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class HostConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HostConfiguration.Builder,HostConfiguration>

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

See Also:

  • Method Details

    • scriptBody

      public final String 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. 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:
      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

      public final Integer scriptTimeoutSeconds()

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

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

    • toBuilder

      public HostConfiguration.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HostConfiguration.Builder,HostConfiguration>
      Returns:
      a builder for type T

    • builder

      public static HostConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HostConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.