RuntimeConfiguration

class aws_cdk.aws_gamelift_alpha.RuntimeConfiguration(*, server_processes, game_session_activation_timeout=None, max_concurrent_game_session_activations=None)

Bases: object

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

Parameters:

server_processes (Sequence[Union[ServerProcess, Dict[str, Any]]]) – (experimental) A collection of server process configurations that identify what server processes to run on each instance in a fleet.
game_session_activation_timeout (Optional[Duration]) – (experimental) The maximum amount of time 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. Default: by default game session activation timeout is 300 seconds
max_concurrent_game_session_activations (Union[int, float, None]) – (experimental) 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. Default: no limit

See:

https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html

Stability:

experimental

ExampleMetadata:

infused

Example:

# build: gamelift.Build

# Server processes can be delcared in a declarative way through the constructor
fleet = gamelift.BuildFleet(self, "Game server fleet",
    fleet_name="test-fleet",
    content=build,
    instance_type=ec2.InstanceType.of(ec2.InstanceClass.C4, ec2.InstanceSize.LARGE),
    runtime_configuration=gamelift.RuntimeConfiguration(
        server_processes=[gamelift.ServerProcess(
            launch_path="/local/game/GameLiftExampleServer.x86_64",
            parameters="-logFile /local/game/logs/myserver1935.log -port 1935",
            concurrent_executions=100
        )]
    )
)

Attributes

game_session_activation_timeout

(experimental) The maximum amount of time 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.

Default:: by default game session activation timeout is 300 seconds
Stability:: experimental

max_concurrent_game_session_activations

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

Default:: no limit
Stability:: experimental

server_processes

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

Stability:: experimental