Amazon GameLift · JSON Structure

Gamelift Instance Definition Structure

This data type is used with the Amazon GameLift FleetIQ and game server groups.

An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. Amazon GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.

Type: object Properties: 2 Required: 1
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

InstanceDefinition is a JSON Structure definition published by Amazon GameLift, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

InstanceType WeightedCapacity

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-instance-definition-structure.json",
  "name": "InstanceDefinition",
  "description": "<p> <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b> </p> <p>An allowed instance type for a game server group. All game server groups must have at least two instance types defined for it. Amazon GameLift FleetIQ periodically evaluates each defined instance type for viability. It then updates the Auto Scaling group with the list of viable instance types.</p>",
  "type": "object",
  "properties": {
    "InstanceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerGroupInstanceType"
        },
        {
          "description": "An Amazon EC2 instance type designation."
        }
      ]
    },
    "WeightedCapacity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WeightedCapacity"
        },
        {
          "description": "Instance weighting that indicates how much this instance type contributes to the total capacity of a game server group. Instance weights are used by Amazon GameLift FleetIQ to calculate the instance type's cost per unit hour and better identify the most cost-effective options. For detailed information on weighting instance capacity, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html\">Instance Weighting</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling User Guide</i>. Default value is \"1\"."
        }
      ]
    }
  },
  "required": [
    "InstanceType"
  ]
}