Package software.amazon.awscdk.services.gamelift.alpha

Interface ServerProcess

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ServerProcess.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-24T02:42:46.484Z") @Stability(Experimental) public interface ServerProcess extends software.amazon.jsii.JsiiSerializable
(experimental) Configuration of a fleet server process.

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.alpha.*;
 ServerProcess serverProcess = ServerProcess.builder()
         .launchPath("launchPath")
         // the properties below are optional
         .concurrentExecutions(123)
         .parameters("parameters")
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    ServerProcess.Builder
    A builder for ServerProcess
    static final class 
    ServerProcess.Jsii$Proxy
    An implementation for ServerProcess

  • Method Summary

    Modifier and Type
    Method
    Description
    static ServerProcess.Builder
    builder()
     
    default Number
    getConcurrentExecutions()
    (experimental) The number of server processes using this configuration that run concurrently on each instance.
    String
    getLaunchPath()
    (experimental) The location of a game build executable or the Realtime script file that contains the Init() function.
    default String
    getParameters()
    (experimental) 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

    • getLaunchPath

      @Stability(Experimental) @NotNull String getLaunchPath()
      (experimental) 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

    • getConcurrentExecutions

      @Stability(Experimental) @Nullable default Number getConcurrentExecutions()
      (experimental) The number of server processes using this configuration that run concurrently on each instance.

      Minimum is 1

      Default: 1

    • getParameters

      @Stability(Experimental) @Nullable default String getParameters()
      (experimental) An optional list of parameters to pass to the server executable or Realtime script on launch.

      Default: no parameters

    • builder

      @Stability(Experimental) static ServerProcess.Builder builder()
      Returns:
      a ServerProcess.Builder of ServerProcess