ServerProcess - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

ServerProcess

A set of instructions for launching server processes on fleet computes. 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.

Contents

Note

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

ConcurrentExecutions

The number of server processes using this configuration that run concurrently on each instance.

Type: Integer

Valid Range: Minimum value of 1.

Required: Yes

LaunchPath

The location of a game build executable or Realtime script. 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"

Note

Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations initSDK() and ProcessReady().

Type: String

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

Pattern: [A-Za-z0-9_:.+\/\\\- ]+

Required: Yes

Parameters

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

Pattern: [A-Za-z0-9_:.+\/\\\- =@{},?'\[\]"]+

Required: No

See Also

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