software.amazon.awscdk.services.gamelift

Interface CfnFleet.ServerProcessProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFleet.ServerProcessProperty.Jsii$Proxy

Enclosing class:

CfnFleet

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

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 software.amazon.awscdk.services.gamelift.*;
 ServerProcessProperty serverProcessProperty = ServerProcessProperty.builder()
         .concurrentExecutions(123)
         .launchPath("launchPath")
         // the properties below are optional
         .parameters("parameters")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnFleet.ServerProcessProperty.Builder	builder()
Number	getConcurrentExecutions() The number of server processes using this configuration that run concurrently on each instance.
String	getLaunchPath() The location of a game build executable or the Realtime script file that contains the `Init()` function.
default String	getParameters() An optional list of parameters to pass to the server executable or Realtime script on launch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getConcurrentExecutions

@Stability(value=Stable)
 @NotNull
Number getConcurrentExecutions()

The number of server processes using this configuration that run concurrently on each instance.

getLaunchPath

@Stability(value=Stable)
 @NotNull
String getLaunchPath()

The location of a game build executable or the Realtime script file that contains the `Init()` function.

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 "

getParameters

@Stability(value=Stable)
 @Nullable
default String getParameters()

An optional list of parameters to pass to the server executable or Realtime script on launch.

builder

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

Returns:

a CfnFleet.ServerProcessProperty.Builder of CfnFleet.ServerProcessProperty