Skip to content
AWS for Query.Farm

aws.gamelift.describe_runtime_configuration

Example SQL Queries

SELECT * FROM
aws.gamelift.describe_runtime_configuration
WHERE
"fleet_id" = 'VALUE';

Description

Retrieves a fleet's runtime configuration settings. The runtime configuration determines which server processes run, and how, on computes in the fleet. For managed EC2 fleets, the runtime configuration describes server processes that run on each fleet instance. For container fleets, the runtime configuration describes server processes that run in each replica container group. You can update a fleet's runtime configuration at any time using UpdateRuntimeConfiguration.

To get the current runtime configuration for a fleet, provide the fleet ID.

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 Amazon GameLift fleets

Running multiple processes on a fleet

Table Definition

Column NameColumn Data Type
fleet_id Required Input Column

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

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
runtime_configuration

Instructions that describe how server processes are launched and maintained on computes in the fleet.

STRUCT(
    "server_processes" STRUCT(
        "launch_path" VARCHAR,
        "parameters" VARCHAR,
        "concurrent_executions" BIGINT
    )[],
    "max_concurrent_game_session_activations" BIGINT,
    "game_session_activation_timeout_seconds" BIGINT
)
Show child fields
runtime_configuration.game_session_activation_timeout_seconds

The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ACTIVATING. If the game session does not become active before the timeout, it is ended and the game session status is changed to TERMINATED.

runtime_configuration.max_concurrent_game_session_activations

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

runtime_configuration.server_processes[]
Show child fields
runtime_configuration.server_processes[].concurrent_executions

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

runtime_configuration.server_processes[].launch_path

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

runtime_configuration.server_processes[].parameters

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