NAME

Paws::GameLift::GameServer

USAGE

This class represents one of two things:

Arguments in a call to a service

Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.

As an example, if Att1 is expected to be a Paws::GameLift::GameServer object:

  $service_obj->Method(Att1 => { ClaimStatus => $value, ..., UtilizationStatus => $value  });

Results returned from an API call

Use accessors for each attribute. If Att1 is expected to be an Paws::GameLift::GameServer object:

  $result = $service_obj->Method(...);
  $result->Att1->ClaimStatus

DESCRIPTION

This data type is used with the 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".

Related actions

ATTRIBUTES

ClaimStatus => Str

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.

ConnectionInfo => Str

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

GameServerData => Str

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.

GameServerGroupArn => Str

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

GameServerGroupName => Str

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

GameServerId => Str

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.

InstanceId => Str

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".

LastClaimTime => Str

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.

LastHealthCheckTime => Str

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.

RegistrationTime => Str

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

UtilizationStatus => Str

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.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>