AWS::GameLift::Fleet ServerProcess - Amazon CloudFormation
SyntaxPropertiesSee also
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).

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 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().

Required: Yes

Type: String

Pattern: ^([Cc]:\\game\S+|/local/game/\S+)

Minimum: 1

Maximum: 1024

Update requires: No interruption

Parameters

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

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

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

Required: No

Type: String

Minimum: 1

Maximum: 1024

Update requires: No interruption

See also