Instance

{
  "$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-schema.json",
  "title": "Instance",
  "description": "<p>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.</p> <p> <b>Related actions</b> </p>",
  "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 (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>."
        }
      ]
    },
    "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": "<p>The DNS identifier assigned to the instance that is running the game session. Values have the following format:</p> <ul> <li> <p>TLS-enabled fleets: <code>&lt;unique identifier&gt;.&lt;region identifier&gt;.amazongamelift.com</code>.</p> </li> <li> <p>Non-TLS-enabled fleets: <code>ec2-&lt;unique identifier&gt;.compute.amazonaws.com</code>. (See <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses\">Amazon EC2 Instance IP Addressing</a>.)</p> </li> </ul> <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>"
        }
      ]
    },
    "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": "<p>Current status of the instance. Possible statuses include the following:</p> <ul> <li> <p> <b>PENDING</b> -- The instance is in the process of being created and launching server processes as defined in the fleet's run-time configuration. </p> </li> <li> <p> <b>ACTIVE</b> -- 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. </p> </li> <li> <p> <b>TERMINATING</b> -- 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.</p> </li> </ul>"
        }
      ]
    },
    "CreationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example <code>\"1469498468.057\"</code>)."
        }
      ]
    },
    "Location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LocationStringModel"
        },
        {
          "description": "The fleet location of the instance, expressed as an Amazon Web Services Region code, such as <code>us-west-2</code>. "
        }
      ]
    }
  }
}