Amazon GameLift · Schema

ServerProcess

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. Server process configurations are part of a fleet's runtime configuration.

Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

Properties

Name Type Description
LaunchPath object
Parameters object
ConcurrentExecutions object
View JSON Schema on GitHub

JSON Schema

gamelift-server-process-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-schema/gamelift-server-process-schema.json",
  "title": "ServerProcess",
  "description": "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. Server process configurations are part of a fleet's runtime configuration.",
  "type": "object",
  "properties": {
    "LaunchPath": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LaunchPathStringModel"
        },
        {
          "description": "<p>The location of a game build executable or the Realtime script file that contains the <code>Init()</code> function. Game builds and Realtime scripts are installed on instances at the root: </p> <ul> <li> <p>Windows (custom game builds only): <code>C:\\game</code>. Example: \"<code>C:\\game\\MyGame\\server.exe</code>\" </p> </li> <li> <p>Linux: <code>/local/game</code>. Examples: \"<code>/local/game/MyGame/server.exe</code>\" or \"<code>/local/game/MyRealtimeScript.js</code>\"</p> </li> </ul>"
        }
      ]
    },
    "Parameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LaunchParametersStringModel"
        },
        {
          "description": "An optional list of parameters to pass to the server executable or Realtime script on launch."
        }
      ]
    },
    "ConcurrentExecutions": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PositiveInteger"
        },
        {
          "description": "The number of server processes using this configuration that run concurrently on each instance."
        }
      ]
    }
  },
  "required": [
    "LaunchPath",
    "ConcurrentExecutions"
  ]
}