Skip to content

ServerProcess

Source code in docs_src/capo_gamelift/types/server_process.py
class ServerProcess(TypedDict, closed=True):
    launch_path: NotRequired[
        "capo_gamelift.types.launch_path_string_model.LaunchPathStringModel"
    ]
    r"""<p>The location of a game build executable or Realtime script. 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> <note> <p>Amazon GameLift Servers 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 <code>initSDK()</code> and <code>ProcessReady()</code>. </p> </note>"""
    parameters: NotRequired[
        "capo_gamelift.types.launch_parameters_string_model.LaunchParametersStringModel"
    ]
    """<p>An optional list of parameters to pass to the server executable or Realtime script on launch.</p>"""
    concurrent_executions: NotRequired[
        "capo_gamelift.types.positive_integer.PositiveInteger"
    ]
    """<p>The number of server processes using this configuration that run concurrently on each instance or compute.</p>"""

concurrent_executions instance-attribute

concurrent_executions: NotRequired[PositiveInteger]

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

launch_path instance-attribute

launch_path: NotRequired[LaunchPathStringModel]

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"

Amazon GameLift Servers 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().

parameters instance-attribute

parameters: NotRequired[LaunchParametersStringModel]

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