You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::GameLift::Types::GameServer

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

This data type is used with the Amazon GameLift FleetIQ and game server groups.

Properties describing a game server that is running on an instance in a GameServerGroup.

A game server is created by a successful call to RegisterGameServer and deleted by calling DeregisterGameServer. A game server is claimed to host a game session by calling ClaimGameServer.

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#claim_status ⇒ String

Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game. Once it is claimed, the game server remains in CLAIMED status for a maximum of one minute. During this time, game clients connect to the game server to start the game and trigger the game server to update its utilization status. After one minute, the game server claim status reverts to null.

Possible values:

  • CLAIMED

Returns:

  • (String) —

    Indicates when an available game server has been reserved for gameplay but has not yet started hosting a game.

#connection_info ⇒ String

The port and IP address that must be used to establish a client connection to the game server.

Returns:

  • (String) —

    The port and IP address that must be used to establish a client connection to the game server.

#game_server_data ⇒ String

A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers using ListGameServers or ClaimGameServer.

Returns:

  • (String) —

    A set of custom game server properties, formatted as a single string value.

#game_server_group_arn ⇒ String

The ARN identifier for the game server group where the game server is located.

Returns:

  • (String) —

    The ARN identifier for the game server group where the game server is located.

#game_server_group_name ⇒ String

A unique identifier for the game server group where the game server is running. Use either the GameServerGroup name or ARN value.

Returns:

  • (String) —

    A unique identifier for the game server group where the game server is running.

#game_server_id ⇒ String

A custom string that uniquely identifies the game server. Game server IDs are developer-defined and are unique across all game server groups in an AWS account.

Returns:

  • (String) —

    A custom string that uniquely identifies the game server.

#instance_id ⇒ String

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: i-1234567890abcdef0.

Returns:

  • (String) —

    The unique identifier for the instance where the game server is running.

#last_claim_time ⇒ Time

Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). This value is used to calculate when a claimed game server\'s status should revert to null.

Returns:

  • (Time) —

    Timestamp that indicates the last time the game server was claimed with a ClaimGameServer request.

#last_health_check_time ⇒ Time

Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057"). After game server registration, this property is only changed when a game server update specifies a health check value.

Returns:

  • (Time) —

    Timestamp that indicates the last time the game server was updated with health status using an UpdateGameServer request.

#registration_time ⇒ Time

Timestamp that indicates when the game server was created with a RegisterGameServer request. The format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Returns:

  • (Time) —

    Timestamp that indicates when the game server was created with a RegisterGameServer request.

#utilization_status ⇒ String

Indicates whether the game server is currently available for new games or is busy. Possible statuses include:

  • AVAILABLE - The game server is available to be claimed. A game server that has been claimed remains in this status until it reports game hosting activity.

  • UTILIZED - The game server is currently hosting a game session with players.

    Possible values:

    • AVAILABLE
    • UTILIZED

Returns:

  • (String) —

    Indicates whether the game server is currently available for new games or is busy.