class Aws::GameLift::Types::GameServerInstance

**This data type is used with the GameLift FleetIQ and game server groups.**

Additional properties, including status, that describe an EC2 instance in a game server group. Instance configurations are set with game server group properties (see `DescribeGameServerGroup` and with the EC2 launch template that was used when creating the game server group.

Retrieve game server instances for a game server group by calling `DescribeGameServerInstances`.

**Related actions**

CreateGameServerGroup | ListGameServerGroups | DescribeGameServerGroup | UpdateGameServerGroup | DeleteGameServerGroup | ResumeGameServerGroup | SuspendGameServerGroup | DescribeGameServerInstances | [All APIs by task]

[1]: docs.aws.amazon.com/gamelift/latest/fleetiqguide/reference-awssdk-fleetiq.html

@!attribute [rw] game_server_group_name

A developer-defined identifier for the game server group that
includes the game server instance. The name is unique for each
Region in each AWS account.
@return [String]

@!attribute [rw] game_server_group_arn

A generated unique identifier for the game server group that
includes the game server instance.
@return [String]

@!attribute [rw] instance_id

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`.
@return [String]

@!attribute [rw] instance_status

Current status of the game server instance.

* **ACTIVE** -- The instance is viable for hosting game servers.

* **DRAINING** -- The instance is not viable for hosting game
  servers. Existing game servers are in the process of ending, and
  new game servers are not started on this instance unless no other
  resources are available. When the instance is put in DRAINING, a
  new instance is started up to replace it. Once the instance has no
  UTILIZED game servers, it will be terminated in favor of the new
  instance.

* **SPOT\_TERMINATING** -- The instance is in the process of
  shutting down due to a Spot instance interruption. No new game
  servers are started on this instance.
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameServerInstance AWS API Documentation

Constants

SENSITIVE