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 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. Learn more about Running Multiple Processes on a Fleet .

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