Amazonka.GameLift.Types.ServerProcess

Documentation

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

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

FromJSON ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

parseJSON :: Value -> Parser ServerProcess

parseJSONList :: Value -> Parser [ServerProcess]

ToJSON ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

toJSON :: ServerProcess -> Value

toEncoding :: ServerProcess -> Encoding

toJSONList :: [ServerProcess] -> Value

toEncodingList :: [ServerProcess] -> Encoding

Generic ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Associated Types

type Rep ServerProcess :: Type -> Type

Methods

from :: ServerProcess -> Rep ServerProcess x

to :: Rep ServerProcess x -> ServerProcess

Read ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

readsPrec :: Int -> ReadS ServerProcess

readList :: ReadS [ServerProcess]

readPrec :: ReadPrec ServerProcess

readListPrec :: ReadPrec [ServerProcess]

Show ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

showsPrec :: Int -> ServerProcess -> ShowS

show :: ServerProcess -> String

showList :: [ServerProcess] -> ShowS

NFData ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

rnf :: ServerProcess -> ()

Eq ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

(==) :: ServerProcess -> ServerProcess -> Bool

(/=) :: ServerProcess -> ServerProcess -> Bool

Hashable ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

Methods

hashWithSalt :: Int -> ServerProcess -> Int

hash :: ServerProcess -> Int

type Rep ServerProcess

Defined in Amazonka.GameLift.Types.ServerProcess

type Rep ServerProcess = D1 ('MetaData "ServerProcess" "Amazonka.GameLift.Types.ServerProcess" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" '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

Arguments

:: Text

$sel:launchPath:ServerProcess'

-> Natural

$sel:concurrentExecutions:ServerProcess'

-> ServerProcess

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)

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

serverProcess_launchPath :: Lens' ServerProcess 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"

serverProcess_concurrentExecutions :: Lens' ServerProcess Natural

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