Gamelift Matchmaking Configuration Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-matchmaking-configuration-structure.json",
  "name": "MatchmakingConfiguration",
  "description": "Guidelines for use with FlexMatch to match players into games. All matchmaking requests must specify a matchmaking configuration.",
  "type": "object",
  "properties": {
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingIdStringModel"
        },
        {
          "description": "A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket."
        }
      ]
    },
    "ConfigurationArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingConfigurationArn"
        },
        {
          "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 matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::matchmakingconfiguration/&lt;matchmaking configuration name&gt;</code>. In a Amazon GameLift configuration ARN, the resource ID matches the <i>Name</i> value."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A descriptive label that is associated with matchmaking configuration."
        }
      ]
    },
    "GameSessionQueueArns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/QueueArnsList"
        },
        {
          "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 game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:&lt;region&gt;::gamesessionqueue/&lt;queue name&gt;</code>. Queues can be located in any Region. Queues are used to start new Amazon GameLift-hosted game sessions for matches that are created with this matchmaking configuration. This property is not set when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>."
        }
      ]
    },
    "RequestTimeoutSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingRequestTimeoutInteger"
        },
        {
          "description": "The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed."
        }
      ]
    },
    "AcceptanceTimeoutSeconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingAcceptanceTimeoutInteger"
        },
        {
          "description": "The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match."
        }
      ]
    },
    "AcceptanceRequired": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BooleanModel"
        },
        {
          "description": "A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. When this option is enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance."
        }
      ]
    },
    "RuleSetName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingIdStringModel"
        },
        {
          "description": "A unique identifier for the matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same Region."
        }
      ]
    },
    "RuleSetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingRuleSetArn"
        },
        {
          "description": "The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) associated with the GameLift matchmaking rule set resource that this configuration uses."
        }
      ]
    },
    "NotificationTarget": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SnsArnStringModel"
        },
        {
          "description": "An SNS topic ARN that is set up to receive matchmaking notifications."
        }
      ]
    },
    "AdditionalPlayerCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WholeNumber"
        },
        {
          "description": "The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>."
        }
      ]
    },
    "CustomEventData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomEventData"
        },
        {
          "description": "Information to attach to all events related to the matchmaking configuration. "
        }
      ]
    },
    "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>)."
        }
      ]
    },
    "GameProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GamePropertyList"
        },
        {
          "description": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>."
        }
      ]
    },
    "GameSessionData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameSessionData"
        },
        {
          "description": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>). This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>."
        }
      ]
    },
    "BackfillMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/BackfillMode"
        },
        {
          "description": "The method used to backfill game sessions created with this matchmaking configuration. MANUAL indicates that the game makes backfill requests or does not use the match backfill feature. AUTOMATIC indicates that GameLift creates backfill requests whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html\">Backfill existing games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>."
        }
      ]
    },
    "FlexMatchMode": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FlexMatchMode"
        },
        {
          "description": "<p>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or as a standalone matchmaking solution. </p> <ul> <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded\"> MatchmakingSucceeded</a> event.</p> </li> <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified Amazon GameLift queue to start a game session for the match. </p> </li> </ul>"
        }
      ]
    }
  }
}