Amazon GameLift · JSON Structure

Gamelift Game Property Structure

Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the Amazon GameLift Developer Guide.

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

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

Properties

Key Value

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-game-property-structure.json",
  "name": "GameProperty",
  "description": "Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create\"> Amazon GameLift Developer Guide</a>.",
  "type": "object",
  "properties": {
    "Key": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GamePropertyKey"
        },
        {
          "description": "The game property identifier."
        }
      ]
    },
    "Value": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GamePropertyValue"
        },
        {
          "description": "The game property value."
        }
      ]
    }
  },
  "required": [
    "Key",
    "Value"
  ]
}