game_server_instances
Creates, updates, deletes, gets or lists a game_server_instances resource.
Overview
| Name | game_server_instances |
| Type | Resource |
| Id | aws.gamelift.game_server_instances |
Fields
The following fields are returned by SELECT queries:
- describe_game_server_instances
| Name | Datatype | Description |
|---|---|---|
game_server_group_arn | string | A generated unique identifier for the game server group that includes the game server instance. (pattern: <code>^arn:.:gameservergroup/[a-zA-Z0-9-.]$</code>) |
game_server_group_name | string | A developer-defined identifier for the game server group that includes the game server instance. The name is unique for each Region in each Amazon Web Services account. (pattern: <code>^[a-zA-Z0-9-.]+$</code>) |
instance_id | string | 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. (pattern: <code>^i-[0-9a-zA-Z]{17}$</code>) |
instance_status | string | Current status of the game server instance (ACTIVE, DRAINING, SPOT_TERMINATING) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_game_server_instances | select | region | This API works with the following fleet types: EC2 (FleetIQ) Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift Servers FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned. This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds. Learn more Amazon GameLift Servers FleetIQ Guide |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_game_server_instances
This API works with the following fleet types: EC2 (FleetIQ) Retrieves status information about the Amazon EC2 instances associated with a Amazon GameLift Servers FleetIQ game server group. Use this operation to detect when instances are active or not available to host new game servers. To request status for all instances in the game server group, provide a game server group ID only. To request status for specific instances, provide the game server group ID and one or more instance IDs. Use the pagination parameters to retrieve results in sequential segments. If successful, a collection of GameServerInstance objects is returned. This operation is not designed to be called with every game server claim request; this practice can cause you to exceed your API limit, which results in errors. Instead, as a best practice, cache the results and refresh your cache no more than once every 10 seconds. Learn more Amazon GameLift Servers FleetIQ Guide
SELECT
game_server_group_arn,
game_server_group_name,
instance_id,
instance_status
FROM aws.gamelift.game_server_instances
WHERE region = '{{ region }}' -- required
;