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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb

Overview

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

RegisterGameServer | ListGameServers | ClaimGameServer | DescribeGameServer | UpdateGameServer | DeregisterGameServer | All APIs by task

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#claim_statusString

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.

Returns:

  • (String)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#connection_infoString

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

Returns:

  • (String)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#game_server_dataString

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)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#game_server_group_arnString

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

Returns:

  • (String)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#game_server_group_nameString

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

Returns:

  • (String)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#game_server_idString

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)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#instance_idString

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)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_claim_timeTime

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)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#last_health_check_timeTime

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)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#registration_timeTime

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)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end

#utilization_statusString

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.

Returns:

  • (String)


4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
# File 'gems/aws-sdk-gamelift/lib/aws-sdk-gamelift/types.rb', line 4859

class GameServer < Struct.new(
  :game_server_group_name,
  :game_server_group_arn,
  :game_server_id,
  :instance_id,
  :connection_info,
  :game_server_data,
  :claim_status,
  :utilization_status,
  :registration_time,
  :last_claim_time,
  :last_health_check_time)
  SENSITIVE = []
  include Aws::Structure
end