aws-cdk-lib.aws_gamelift.CfnFleet.RuntimeConfigurationProperty

interface RuntimeConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.GameLift.CfnFleet.RuntimeConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnFleet_RuntimeConfigurationProperty
Javasoftware.amazon.awscdk.services.gamelift.CfnFleet.RuntimeConfigurationProperty
Pythonaws_cdk.aws_gamelift.CfnFleet.RuntimeConfigurationProperty
TypeScript aws-cdk-lib » aws_gamelift » CfnFleet » RuntimeConfigurationProperty

Obtainable from FleetBase.parseRuntimeConfiguration()

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 { aws_gamelift as gamelift } from 'aws-cdk-lib';
const runtimeConfigurationProperty: gamelift.CfnFleet.RuntimeConfigurationProperty = {
  gameSessionActivationTimeoutSeconds: 123,
  maxConcurrentGameSessionActivations: 123,
  serverProcesses: [{
    concurrentExecutions: 123,
    launchPath: 'launchPath',

    // the properties below are optional
    parameters: 'parameters',
  }],
};

Properties

NameTypeDescription
gameSessionActivationTimeoutSeconds?numberThe maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players.
maxConcurrentGameSessionActivations?numberThe number of game sessions in status ACTIVATING to allow on an instance.
serverProcesses?IResolvable | IResolvable | ServerProcessProperty[]A collection of server process configurations that identify what server processes to run on each instance in a fleet.

gameSessionActivationTimeoutSeconds?

Type: number (optional)

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?

Type: number (optional)

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?

Type: IResolvable | IResolvable | ServerProcessProperty[] (optional)

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