{ "$schema": "https://json-structure.org/meta/core/v0/#", "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-instance-structure.json", "name": "Instance", "description": "
Represents an EC2 instance of virtual computing resources that hosts one or more game servers. In Amazon GameLift, a fleet can contain zero or more instances.
Related actions
", "type": "object", "properties": { "FleetId": { "allOf": [ { "$ref": "#/components/schemas/FleetId" }, { "description": "A unique identifier for the fleet that the instance is in." } ] }, "FleetArn": { "allOf": [ { "$ref": "#/components/schemas/FleetArn" }, { "description": "The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format isarn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912."
}
]
},
"InstanceId": {
"allOf": [
{
"$ref": "#/components/schemas/InstanceId"
},
{
"description": "A unique identifier for the instance."
}
]
},
"IpAddress": {
"allOf": [
{
"$ref": "#/components/schemas/IpAddress"
},
{
"description": "IP address that is assigned to the instance."
}
]
},
"DnsName": {
"allOf": [
{
"$ref": "#/components/schemas/DnsName"
},
{
"description": "The DNS identifier assigned to the instance that is running the game session. Values have the following format:
TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
" } ] }, "OperatingSystem": { "allOf": [ { "$ref": "#/components/schemas/OperatingSystem" }, { "description": "Operating system that is running on this instance. " } ] }, "Type": { "allOf": [ { "$ref": "#/components/schemas/EC2InstanceType" }, { "description": "Amazon EC2 instance type that defines the computing resources of this instance. " } ] }, "Status": { "allOf": [ { "$ref": "#/components/schemas/InstanceStatus" }, { "description": "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.
\"1469498468.057\")."
}
]
},
"Location": {
"allOf": [
{
"$ref": "#/components/schemas/LocationStringModel"
},
{
"description": "The fleet location of the instance, expressed as an Amazon Web Services Region code, such as us-west-2. "
}
]
}
}
}