AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

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

Overview

Note:

When passing ClaimGameServerInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  game_server_group_name: "GameServerGroupNameOrArn", # required
  game_server_id: "GameServerId",
  game_server_data: "GameServerData",
}

Instance Attribute Summary collapse

Instance Attribute Details

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

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

#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.. If you are not specifying a game server to claim, this value identifies where you want GameLift FleetIQ to look for an available game server to claim.

Returns:

  • (String)

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

#game_server_idString

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

Returns:

  • (String)

    A custom string that uniquely identifies the game server to claim.