AWS App Mesh · Schema

Listeners

Listeners schema from AWS App Mesh

DeprecatedEnvoyMicroservicesNetworkingService Mesh
View JSON Schema on GitHub

JSON Schema

app-mesh-listeners-schema.json Raw ↑
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "connectionPool": {
        "allOf": [
          {
            "$ref": "#/components/schemas/VirtualNodeConnectionPool"
          },
          {
            "description": "The connection pool information for the listener."
          }
        ]
      },
      "healthCheck": {
        "allOf": [
          {
            "$ref": "#/components/schemas/HealthCheckPolicy"
          },
          {
            "description": "The health check information for the listener."
          }
        ]
      },
      "outlierDetection": {
        "allOf": [
          {
            "$ref": "#/components/schemas/OutlierDetection"
          },
          {
            "description": "The outlier detection information for the listener."
          }
        ]
      },
      "portMapping": {
        "allOf": [
          {
            "$ref": "#/components/schemas/PortMapping"
          },
          {
            "description": "The port mapping information for the listener."
          }
        ]
      },
      "timeout": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ListenerTimeout"
          },
          {
            "description": "An object that represents timeouts for different protocols."
          }
        ]
      },
      "tls": {
        "allOf": [
          {
            "$ref": "#/components/schemas/ListenerTls"
          },
          {
            "description": "A reference to an object that represents the Transport Layer Security (TLS) properties for a listener."
          }
        ]
      }
    },
    "required": [
      "portMapping"
    ],
    "description": "An object that represents a listener for a virtual node."
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-app-mesh/refs/heads/main/json-schema/app-mesh-listeners-schema.json",
  "title": "Listeners",
  "description": "Listeners schema from AWS App Mesh"
}