Package 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(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();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	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 Realtime script.
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 Details

getConcurrentExecutions

@Stability(Stable)
@NotNull
Number getConcurrentExecutions()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions

getLaunchPath

@Stability(Stable)
@NotNull
String getLaunchPath()

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() and ProcessReady() .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-launchpath

getParameters

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

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_:.+/- =@{},?'[]"]+

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-parameters

builder

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

Returns:

a CfnFleet.ServerProcessProperty.Builder of CfnFleet.ServerProcessProperty