libZSservicesZSamazonka-gameliftZSamazonka-gamelift
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.GameLift.Types.ServerProcess

Description

 
Synopsis

Documentation

data ServerProcess Source #

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. Server process configurations are part of a fleet's RuntimeConfiguration.

See: newServerProcess smart constructor.

Constructors

ServerProcess' 

Fields

  • parameters :: Maybe Text

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

  • launchPath :: Text

    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"
  • concurrentExecutions :: Natural

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

Instances

Instances details
Eq ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

Read ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

Show ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

Generic ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

Associated Types

type Rep ServerProcess :: Type -> Type #

NFData ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

rnf :: ServerProcess -> () #

Hashable ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

ToJSON ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

FromJSON ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

type Rep ServerProcess Source # 
Instance details

Defined in Amazonka.GameLift.Types.ServerProcess

type Rep ServerProcess = D1 ('MetaData "ServerProcess" "Amazonka.GameLift.Types.ServerProcess" "libZSservicesZSamazonka-gameliftZSamazonka-gamelift" 'False) (C1 ('MetaCons "ServerProcess'" 'PrefixI 'True) (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "launchPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "concurrentExecutions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural))))

newServerProcess Source #

Create a value of ServerProcess with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:parameters:ServerProcess', serverProcess_parameters - An optional list of parameters to pass to the server executable or Realtime script on launch.

$sel:launchPath:ServerProcess', serverProcess_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"

$sel:concurrentExecutions:ServerProcess', serverProcess_concurrentExecutions - The number of server processes using this configuration that run concurrently on each instance.

serverProcess_parameters :: Lens' ServerProcess (Maybe Text) Source #

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

serverProcess_launchPath :: Lens' ServerProcess Text Source #

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"

serverProcess_concurrentExecutions :: Lens' ServerProcess Natural Source #

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