Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

Instance

Properties that describe an instance of a virtual computing resource that hosts one or more game servers. A fleet may contain zero or more instances.

Contents

Note

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

CreationTime

Time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").

Type: Timestamp

Required: No

FleetId

Unique identifier for a fleet that the instance is in.

Type: String

Pattern: ^fleet-\S+

Required: No

InstanceId

Unique identifier for an instance.

Type: String

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

Required: No

IpAddress

IP address assigned to the instance.

Type: String

Required: No

OperatingSystem

Operating system that is running on this instance.

Type: String

Valid Values: WINDOWS_2012 | AMAZON_LINUX

Required: No

Status

Current status of the instance. Possible statuses include the following:

  • PENDING -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration.

  • ACTIVE -- The instance has been successfully created and at least one server process has successfully launched and reported back to Amazon GameLift that it is ready to host a game session. The instance is now considered ready to host game sessions.

  • TERMINATING -- The instance is in the process of shutting down. This may happen to reduce capacity during a scaling down event or to recycle resources in the event of a problem.

Type: String

Valid Values: PENDING | ACTIVE | TERMINATING

Required: No

Type

EC2 instance type that defines the computing resources of this instance.

Type: String

Valid Values: t2.micro | t2.small | t2.medium | t2.large | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge

Required: No

See Also

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

On this page: