AWS::GameLift::Fleet 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.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "ConcurrentExecutions" :
Integer
, "LaunchPath" :String
, "Parameters" :String
}
YAML
ConcurrentExecutions:
Integer
LaunchPath:String
Parameters:String
Properties
ConcurrentExecutions
-
The number of server processes using this configuration that run concurrently on each instance.
Required: Yes
Type: Integer
Minimum:
1
Update requires: No interruption
LaunchPath
-
The location of a game build executable or the Realtime script file that contains the
Init()
function. 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
"
Required: Yes
Type: String
Minimum:
1
Maximum:
1024
Pattern:
[A-Za-z0-9_:.+\/\\\- ]+
Update requires: No interruption
-
Parameters
-
An optional list of parameters to pass to the server executable or Realtime script on launch.
Required: No
Type: String
Minimum:
1
Maximum:
1024
Pattern:
[A-Za-z0-9_:.+\/\\\- =@;{},?'\[\]"]+
Update requires: No interruption
See also
Create GameLift resources using Amazon CloudFront in the Amazon GameLift Developer Guide
Deploy a GameLift fleet for a custom game build in the Amazon GameLift Developer Guide
Deploy a Realtime Servers fleet in the Amazon GameLift Developer Guide
Run multiple processes on a fleet in the Amazon GameLift Developer Guide
ServerProcess in the Amazon GameLift API Reference