Interface CfnFleet.ServerProcessProperty

All Superinterfaces:
All Known Implementing Classes:
Enclosing class:

@Stability(Stable) public static interface CfnFleet.ServerProcessProperty extends
A set of instructions for launching server processes on each instance in a fleet.

Server processes run either an executable in a custom game build or a Realtime Servers script.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 ServerProcessProperty serverProcessProperty = ServerProcessProperty.builder()
         // the properties below are optional
  • Method Details

    • getConcurrentExecutions

      @Stability(Stable) @NotNull Number getConcurrentExecutions()
      The number of server processes using this configuration that run concurrently on each instance.
    • getLaunchPath

      @Stability(Stable) @NotNull String getLaunchPath()
      The location of a game build executable or the Realtime script file that contains the Init() function.

      Game builds and Realtime scripts are installed on instances at the root:

      • Windows (custom game builds only): C:\game . Example: " C:\game\MyGame\server.exe "
      • Linux: /local/game . Examples: " /local/game/MyGame/server.exe " or " /local/game/MyRealtimeScript.js "
    • getParameters

      @Stability(Stable) @Nullable default String getParameters()
      An optional list of parameters to pass to the server executable or Realtime script on launch.
    • builder

      @Stability(Stable) static CfnFleet.ServerProcessProperty.Builder builder()
      a CfnFleet.ServerProcessProperty.Builder of CfnFleet.ServerProcessProperty