GameServerInstance - GameLift Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

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

Contents

Note

In the following list, the required parameters are described first.

GameServerGroupArn

A generated unique identifier for the game server group that includes the game server instance.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^arn:.*:gameservergroup\/[a-zA-Z0-9-\.]*

Required: No

GameServerGroupName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9-\.]+

Required: No

InstanceId

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.

Type: String

Length Constraints: Fixed length of 19.

Pattern: ^i-[0-9a-zA-Z]{17}$

Required: No

InstanceStatus

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.

Type: String

Valid Values: ACTIVE | DRAINING | SPOT_TERMINATING

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: