Amazon GameLift · JSON Structure

Gamelift Routing Strategy Structure

The routing configuration for a fleet alias.

Related actions

All APIs by task

Type: object Properties: 3
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

RoutingStrategy is a JSON Structure definition published by Amazon GameLift, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

Type FleetId Message

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-routing-strategy-structure.json",
  "name": "RoutingStrategy",
  "description": "<p>The routing configuration for a fleet alias.</p> <p> <b>Related actions</b> </p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>",
  "type": "object",
  "properties": {
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoutingStrategyType"
        },
        {
          "description": "<p>The type of routing strategy for the alias.</p> <p>Possible routing types include the following:</p> <ul> <li> <p> <b>SIMPLE</b> - The alias resolves to one specific fleet. Use this type when routing to active fleets.</p> </li> <li> <p> <b>TERMINAL</b> - The alias does not resolve to a fleet but instead can be used to display a message to the user. A terminal alias throws a TerminalRoutingStrategyException with the message embedded.</p> </li> </ul>"
        }
      ]
    },
    "FleetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetId"
        },
        {
          "description": "A unique identifier for the fleet that the alias points to. This value is the fleet ID, not the fleet ARN."
        }
      ]
    },
    "Message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FreeText"
        },
        {
          "description": "The message text to be used with a terminal routing strategy."
        }
      ]
    }
  }
}