AWS App Mesh · JSON Structure

App Mesh Route Data Structure

An object that represents a route returned by a describe operation.

Type: object Properties: 6 Required: 6

DeprecatedEnvoyMicroservicesNetworkingService Mesh

RouteData is a JSON Structure definition published by AWS App Mesh, describing 6 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

meshName metadata routeName spec status virtualRouterName

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "type": "object",
  "properties": {
    "meshName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of the service mesh that the route resides in."
        }
      ]
    },
    "metadata": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceMetadata"
        },
        {
          "description": "The associated metadata for the route."
        }
      ]
    },
    "routeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of the route."
        }
      ]
    },
    "spec": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RouteSpec"
        },
        {
          "description": "The specifications of the route."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RouteStatus"
        },
        {
          "description": "The status of the route."
        }
      ]
    },
    "virtualRouterName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The virtual router that the route is associated with."
        }
      ]
    }
  },
  "required": [
    "meshName",
    "metadata",
    "routeName",
    "spec",
    "status",
    "virtualRouterName"
  ],
  "description": "An object that represents a route returned by a describe operation.",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-app-mesh/refs/heads/main/json-structure/app-mesh-route-data-structure.json",
  "name": "RouteData"
}