AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::ServerProcess

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ServerProcess as input to an Aws::Client method, you can use a vanilla Hash:

{
  launch_path: "NonZeroAndMaxString", # required
  parameters: "NonZeroAndMaxString",
  concurrent_executions: 1, # required
}

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 .

Instance Attribute Summary collapse

Instance Attribute Details

#concurrent_executionsInteger

The number of server processes that use this configuration to run concurrently on an instance.

Returns:

  • (Integer)

    The number of server processes that use this configuration to run concurrently on an instance.

#launch_pathString

The 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\"

Returns:

  • (String)

    The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function.

#parametersString

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

Returns:

  • (String)

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