[ aws . gamelift ]

describe-runtime-configuration

Description

Retrieves a fleet’s runtime configuration settings. The runtime configuration tells Amazon GameLift which server processes to run (and how) on each instance in the fleet.

To get a runtime configuration, specify the fleet’s unique identifier. If successful, a RuntimeConfiguration object is returned for the requested fleet. If the requested fleet has been deleted, the result set is empty.

Learn more

Setting up GameLift Fleets

Running Multiple Processes on a Fleet

Related operations

• CreateFleet

• ListFleets

• DeleteFleet

• Describe fleets:

  • DescribeFleetAttributes

  • DescribeFleetCapacity

  • DescribeFleetPortSettings

  • DescribeFleetUtilization

  • DescribeRuntimeConfiguration

  • DescribeEC2InstanceLimits

  • DescribeFleetEvents

• UpdateFleetAttributes

• StartFleetActions or StopFleetActions

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-runtime-configuration
--fleet-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--fleet-id (string)

A unique identifier for a fleet to get the runtime configuration for. You can use either the fleet ID or ARN value.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To request the runtime configuration for a fleet

The following describe-runtime-configuration example retrieves details about the current runtime configuration for a specified fleet.

aws gamelift describe-runtime-configuration \
    --fleet-id fleet-a1b2c3d4-5678-90ab-cdef-EXAMPLE11111

Output:

{
    "RuntimeConfiguration": {
        "ServerProcesses": [
            {
                "LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe",
                "Parameters": "+gamelift_start_server",
                "ConcurrentExecutions": 3
            },
            {
                "LaunchPath": "C:\game\Bin64.Release.Dedicated\MegaFrogRace_Server.exe",
                "Parameters": "+gamelift_start_server +debug",
                "ConcurrentExecutions": 1
            }
        ],
        "MaxConcurrentGameSessionActivations": 2147483647,
        "GameSessionActivationTimeoutSeconds": 300
    }
}

For more information, see Run Multiple Processes on a Fleet in the Amazon GameLift Developer Guide.

Output

RuntimeConfiguration -> (structure)

Instructions describing how server processes should be launched and maintained on each instance in the fleet.

ServerProcesses -> (list)

A collection of server process configurations that describe which server processes to run on each instance in a fleet.

(structure)

A set of instructions for launching server processes on each instance in a fleet. Server processes run either a custom game build executable or a Realtime Servers script. Each instruction set identifies the location of the custom game build executable or Realtime launch script, optional launch parameters, and the number of server processes with this configuration to maintain concurrently on the instance. Server process configurations make up a fleet’s `` RuntimeConfiguration `` .

LaunchPath -> (string)

The location of the server executable in a custom game build or the name of the Realtime script file that contains the Init() function. Game builds and Realtime scripts are installed on instances at the root:

• Windows (for 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 “

Parameters -> (string)

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

ConcurrentExecutions -> (integer)

The number of server processes that use this configuration to run concurrently on an instance.

MaxConcurrentGameSessionActivations -> (integer)

The maximum number of game sessions with status ACTIVATING to allow on an instance simultaneously. This setting limits the amount of instance resources that can be used for new game activations at any one time.

GameSessionActivationTimeoutSeconds -> (integer)

The maximum amount of time (in seconds) that a game session can remain in status ACTIVATING . If the game session is not active before the timeout, activation is terminated and the game session status is changed to TERMINATED .