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::UpdateGameServerInput

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

Overview

Note:

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

{
  game_server_group_name: "GameServerGroupNameOrArn", # required
  game_server_id: "GameServerId", # required
  game_server_data: "GameServerData",
  utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
  health_check: "HEALTHY", # accepts HEALTHY
}

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.

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

Returns:

  • (String)

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

#health_checkString

Indicates health status of the game server. A request that includes this parameter updates the game server\'s LastHealthCheckTime timestamp.

Possible values:

  • HEALTHY

Returns:

  • (String)

    Indicates health status of the game server.

#utilization_statusString

Indicates whether the game server is available or is currently hosting gameplay.

Possible values:

  • AVAILABLE
  • UTILIZED

Returns:

  • (String)

    Indicates whether the game server is available or is currently hosting gameplay.