AWS App Mesh · JSON Structure

App Mesh Listener Structure

An object that represents a listener for a virtual node.

Type: object Properties: 6 Required: 1

DeprecatedEnvoyMicroservicesNetworkingService Mesh

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

Properties

connectionPool healthCheck outlierDetection portMapping timeout tls

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

JSON Structure

{
  "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-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/aws-app-mesh/refs/heads/main/json-structure/app-mesh-listener-structure.json",
  "name": "Listener"
}