Class: Aws::GameLift::Types::ClaimGameServerInput

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#filter_option ⇒ Types::ClaimFilterOption

Object that restricts how a claimed game server is chosen.

Returns:



396
397
398
399
400
401
402
403
 
# File 'lib/aws-sdk-gamelift/types.rb', line 396

class ClaimGameServerInput < Struct.new(
  :game_server_group_name,
  :game_server_id,
  :game_server_data,
  :filter_option)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

  • (String) 


396
397
398
399
400
401
402
403
 
# File 'lib/aws-sdk-gamelift/types.rb', line 396

class ClaimGameServerInput < Struct.new(
  :game_server_group_name,
  :game_server_id,
  :game_server_data,
  :filter_option)
  SENSITIVE = []
  include Aws::Structure
end

#game_server_group_name ⇒ String

A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift Servers FleetIQ to look for an available game server to claim.

Returns:

  • (String) 


396
397
398
399
400
401
402
403
 
# File 'lib/aws-sdk-gamelift/types.rb', line 396

class ClaimGameServerInput < Struct.new(
  :game_server_group_name,
  :game_server_id,
  :game_server_data,
  :filter_option)
  SENSITIVE = []
  include Aws::Structure
end

#game_server_id ⇒ String

A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift Servers FleetIQ searches for an available game server in the specified game server group.

Returns:

  • (String) 


396
397
398
399
400
401
402
403
 
# File 'lib/aws-sdk-gamelift/types.rb', line 396

class ClaimGameServerInput < Struct.new(
  :game_server_group_name,
  :game_server_id,
  :game_server_data,
  :filter_option)
  SENSITIVE = []
  include Aws::Structure
end