AWS App Mesh · Schema

Listener

An object that represents a listener for a virtual node.

DeprecatedEnvoyMicroservicesNetworkingService Mesh

Properties

Name Type Description
connectionPool object
healthCheck object
outlierDetection object
portMapping object
timeout object
tls object
View JSON Schema on GitHub

JSON Schema

app-mesh-listener-schema.json Raw ↑
{
  "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-listener-schema.json",
  "title": "Listener"
}