Amazon GameLift · Schema

InstanceDefinition

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.

Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

Properties

Name Type Description
InstanceType object
WeightedCapacity object
View JSON Schema on GitHub

JSON Schema

gamelift-instance-definition-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-schema/gamelift-instance-definition-schema.json",
  "title": "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"
  ]
}