software.amazon.awscdk.services.gamelift

Interface CfnFleet.RuntimeConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.RuntimeConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnFleet

@Stability(value=Stable)
public static interface CfnFleet.RuntimeConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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

All fleets must have a runtime configuration. Each instance in the fleet maintains server processes as specified in the runtime configuration, launching new ones as existing processes end. Each instance regularly checks for an updated runtime configuration makes adjustments as called for.

The runtime configuration enables the instances in a fleet to run multiple processes simultaneously. Potential scenarios are as follows: (1) Run multiple processes of a single game server executable to maximize usage of your hosting resources. (2) Run one or more processes of different executables, such as your game server and a metrics tracking program. (3) Run multiple processes of a single game server but with different launch parameters, for example to run one process on each instance in debug mode.

An Amazon GameLift instance is limited to 50 processes running simultaneously. A runtime configuration must specify fewer than this limit. To calculate the total number of processes specified in a runtime configuration, add the values of the ConcurrentExecutions parameter for each ServerProcess object in the runtime configuration.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.gamelift.*;
 RuntimeConfigurationProperty runtimeConfigurationProperty = RuntimeConfigurationProperty.builder()
         .gameSessionActivationTimeoutSeconds(123)
         .maxConcurrentGameSessionActivations(123)
         .serverProcesses(List.of(ServerProcessProperty.builder()
                 .concurrentExecutions(123)
                 .launchPath("launchPath")
                 // the properties below are optional
                 .parameters("parameters")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFleet.RuntimeConfigurationProperty.Builder A builder for CfnFleet.RuntimeConfigurationProperty
static class	CfnFleet.RuntimeConfigurationProperty.Jsii$Proxy An implementation for CfnFleet.RuntimeConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnFleet.RuntimeConfigurationProperty.Builder	builder()
default Number	getGameSessionActivationTimeoutSeconds() The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players.
default Number	getMaxConcurrentGameSessionActivations() The number of game sessions in status `ACTIVATING` to allow on an instance.
default Object	getServerProcesses() A collection of server process configurations that identify what server processes to run on each instance in a fleet.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGameSessionActivationTimeoutSeconds

@Stability(value=Stable)
 @Nullable
default Number getGameSessionActivationTimeoutSeconds()

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 .

getMaxConcurrentGameSessionActivations

@Stability(value=Stable)
 @Nullable
default Number getMaxConcurrentGameSessionActivations()

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.

getServerProcesses

@Stability(value=Stable)
 @Nullable
default Object getServerProcesses()

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

builder

@Stability(value=Stable)
static CfnFleet.RuntimeConfigurationProperty.Builder builder()

Returns:

a CfnFleet.RuntimeConfigurationProperty.Builder of CfnFleet.RuntimeConfigurationProperty