Class RuntimeConfiguration

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

This data type has been expanded to use with the Amazon GameLift containers feature, which is currently in public preview.

A set of instructions that define the set of server processes to run on computes in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. Amazon GameLift launches the processes, manages their life cycle, and replaces them as needed. Computes check regularly for an updated runtime configuration.

On a container fleet, the Amazon GameLift Agent uses the runtime configuration to manage the lifecycle of server processes in a replica container group.

An Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes defined in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet.

See Also:

  • Method Details

    • hasServerProcesses

      public final boolean hasServerProcesses()
      For responses, this returns true if the service returned a value for the ServerProcesses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • serverProcesses

      public final List<ServerProcess> serverProcesses()

      A collection of server process configurations that identify what server processes to run on fleet computes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasServerProcesses() method.

      Returns:
      A collection of server process configurations that identify what server processes to run on fleet computes.

    • maxConcurrentGameSessionActivations

      public final Integer maxConcurrentGameSessionActivations()

      The number of game sessions in status ACTIVATING to allow on an instance or container. This setting limits the instance resources that can be used for new game activations at any one time.

      Returns:
      The number of game sessions in status ACTIVATING to allow on an instance or container. This setting limits the instance resources that can be used for new game activations at any one time.

    • gameSessionActivationTimeoutSeconds

      public final Integer gameSessionActivationTimeoutSeconds()

      The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

      Returns:
      The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

    • toBuilder

      public RuntimeConfiguration.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<RuntimeConfiguration.Builder,RuntimeConfiguration>
      Returns:
      a builder for type T

    • builder

      public static RuntimeConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RuntimeConfiguration.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.