interface ServerProcessProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.GameLift.CfnFleet.ServerProcessProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsgamelift#CfnFleet_ServerProcessProperty |
![]() | software.amazon.awscdk.services.gamelift.CfnFleet.ServerProcessProperty |
![]() | aws_cdk.aws_gamelift.CfnFleet.ServerProcessProperty |
![]() | aws-cdk-lib » aws_gamelift » CfnFleet » ServerProcessProperty |
A set of instructions for launching server processes on each instance in a fleet.
Server processes run either an executable in a custom game build or a Realtime Servers script.
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 serverProcessProperty: gamelift.CfnFleet.ServerProcessProperty = {
concurrentExecutions: 123,
launchPath: 'launchPath',
// the properties below are optional
parameters: 'parameters',
};
Properties
Name | Type | Description |
---|---|---|
concurrent | number | The number of server processes using this configuration that run concurrently on each instance or compute. |
launch | string | The location of a game build executable or Realtime script. |
parameters? | string | An optional list of parameters to pass to the server executable or Realtime script on launch. |
concurrentExecutions
Type:
number
The number of server processes using this configuration that run concurrently on each instance or compute.
launchPath
Type:
string
The location of a game build executable or Realtime script.
Game builds and Realtime scripts are installed on instances at the root:
- Windows (custom game builds only):
C:\game
. Example: "C:\game\MyGame\server.exe
" - Linux:
/local/game
. Examples: "/local/game/MyGame/server.exe
" or "/local/game/MyRealtimeScript.js
"
Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations
initSDK()
andProcessReady()
.
parameters?
Type:
string
(optional)
An optional list of parameters to pass to the server executable or Realtime script on launch.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern: [A-Za-z0-9_:.+/\- =@{},?'[]"]+