Amazon GameLift Service
API Reference (API Version 2015-10-01)

ServerProcess

A set of instructions for launching server processes on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instruction set identifies the location of the custom game build executable or Realtime launch script, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet's RuntimeConfiguration .

Contents

Note

In the following list, the required parameters are described first.

ConcurrentExecutions

Number of server processes using this configuration to run concurrently on an instance.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

LaunchPath

Location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

  • Windows (for 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"

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

Parameters

Optional list of parameters to pass to the server executable or Realtime script on launch.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: