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

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

Overview

This data type is used with the Amazon 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.

Instance Attribute Summary collapse

Instance Attribute Details

#game_server_group_arnString

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

Returns:

  • (String)

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

#game_server_group_nameString

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.

Returns:

  • (String)

    A developer-defined identifier for the game server group that includes the game server instance.

#instance_idString

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.

Returns:

  • (String)

    The unique identifier for the instance where the game server is running.

#instance_statusString

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.

    Possible values:

    • ACTIVE
    • DRAINING
    • SPOT_TERMINATING

Returns:

  • (String)

    Current status of the game server instance.