Class: AWSCDK::GameLift::CfnFleet::ServerProcessProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
game_lift/cfn_fleet.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(concurrent_executions:, launch_path:, parameters: nil) ⇒ ServerProcessProperty

Returns a new instance of ServerProcessProperty.

Parameters:

  • concurrent_executions (Numeric) —

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

  • launch_path (String) —

    The location of a game build executable or Realtime script.

  • parameters (String, nil) (defaults to: nil) —

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



1598
1599
1600
1601
1602
1603
1604
1605
 
# File 'game_lift/cfn_fleet.rb', line 1598

def initialize(concurrent_executions:, launch_path:, parameters: nil)
  @concurrent_executions = concurrent_executions
  Jsii::Type.check_type(@concurrent_executions, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "concurrentExecutions")
  @launch_path = launch_path
  Jsii::Type.check_type(@launch_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "launchPath")
  @parameters = parameters
  Jsii::Type.check_type(@parameters, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameters") unless @parameters.nil?
end

Instance Attribute Details

#concurrent_executions ⇒ Numeric (readonly)

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

Returns:

  • (Numeric)

See Also:



1611
1612
1613
 
# File 'game_lift/cfn_fleet.rb', line 1611

def concurrent_executions
  @concurrent_executions
end

#launch_path ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



1623
1624
1625
 
# File 'game_lift/cfn_fleet.rb', line 1623

def launch_path
  @launch_path
end

#parameters ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



1632
1633
1634
 
# File 'game_lift/cfn_fleet.rb', line 1632

def parameters
  @parameters
end

Class Method Details

.jsii_properties ⇒ Object 



1634
1635
1636
1637
1638
1639
1640
 
# File 'game_lift/cfn_fleet.rb', line 1634

def self.jsii_properties
  {
    :concurrent_executions => "concurrentExecutions",
    :launch_path => "launchPath",
    :parameters => "parameters",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1642
1643
1644
1645
1646
1647
1648
1649
1650
 
# File 'game_lift/cfn_fleet.rb', line 1642

def to_jsii
  result = {}
  result.merge!({
    "concurrentExecutions" => @concurrent_executions,
    "launchPath" => @launch_path,
    "parameters" => @parameters,
  })
  result.compact
end