amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.Types.RuntimeConfiguration

Description

 
Synopsis

Documentation

data RuntimeConfiguration Source #

A collection of server process configurations that describe the set of processes to run on each instance in a fleet. Server processes run either an executable in a custom game build or a Realtime Servers script. GameLift launches the configured processes, manages their life cycle, and replaces them as needed. Each instance checks regularly for an updated runtime configuration.

A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ConcurrentExecutions parameter for each server process. Learn more about Running Multiple Processes on a Fleet.

See: newRuntimeConfiguration smart constructor.

Constructors

RuntimeConfiguration' 

Fields

  • gameSessionActivationTimeoutSeconds :: Maybe Natural

    The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

  • maxConcurrentGameSessionActivations :: Maybe Natural

    The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.

  • serverProcesses :: Maybe (NonEmpty ServerProcess)

    A collection of server process configurations that identify what server processes to run on each instance in a fleet.

Instances

Instances details
FromJSON RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

ToJSON RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

Generic RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

Associated Types

type Rep RuntimeConfiguration :: Type -> Type #

Read RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

Show RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

NFData RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

Methods

rnf :: RuntimeConfiguration -> () #

Eq RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

Hashable RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

type Rep RuntimeConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.Types.RuntimeConfiguration

type Rep RuntimeConfiguration = D1 ('MetaData "RuntimeConfiguration" "Amazonka.GameLift.Types.RuntimeConfiguration" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "RuntimeConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "gameSessionActivationTimeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "maxConcurrentGameSessionActivations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "serverProcesses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty ServerProcess))))))

newRuntimeConfiguration :: RuntimeConfiguration Source #

Create a value of RuntimeConfiguration 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:gameSessionActivationTimeoutSeconds:RuntimeConfiguration', runtimeConfiguration_gameSessionActivationTimeoutSeconds - The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

$sel:maxConcurrentGameSessionActivations:RuntimeConfiguration', runtimeConfiguration_maxConcurrentGameSessionActivations - The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.

$sel:serverProcesses:RuntimeConfiguration', runtimeConfiguration_serverProcesses - A collection of server process configurations that identify what server processes to run on each instance in a fleet.

runtimeConfiguration_gameSessionActivationTimeoutSeconds :: Lens' RuntimeConfiguration (Maybe Natural) Source #

The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

runtimeConfiguration_maxConcurrentGameSessionActivations :: Lens' RuntimeConfiguration (Maybe Natural) Source #

The number of game sessions in status ACTIVATING to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.

runtimeConfiguration_serverProcesses :: Lens' RuntimeConfiguration (Maybe (NonEmpty ServerProcess)) Source #

A collection of server process configurations that identify what server processes to run on each instance in a fleet.