AWS App Mesh · JSON Structure

App Mesh Outlier Detection Structure

An object that represents the outlier detection for a virtual node's listener.

Type: object Properties: 4 Required: 4
DeprecatedEnvoyMicroservicesNetworkingService Mesh

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

Properties

baseEjectionDuration interval maxEjectionPercent maxServerErrors

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

JSON Structure

Raw ↑
{
  "type": "object",
  "properties": {
    "baseEjectionDuration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Duration"
        },
        {
          "description": "The base amount of time for which a host is ejected."
        }
      ]
    },
    "interval": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Duration"
        },
        {
          "description": "The time interval between ejection sweep analysis."
        }
      ]
    },
    "maxEjectionPercent": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OutlierDetectionMaxEjectionPercent"
        },
        {
          "description": "Maximum percentage of hosts in load balancing pool for upstream service that can be ejected. Will eject at least one host regardless of the value."
        }
      ]
    },
    "maxServerErrors": {
      "allOf": [
        {
          "$ref": "#/components/schemas/OutlierDetectionMaxServerErrors"
        },
        {
          "description": "Number of consecutive <code>5xx</code> errors required for ejection. "
        }
      ]
    }
  },
  "required": [
    "baseEjectionDuration",
    "interval",
    "maxEjectionPercent",
    "maxServerErrors"
  ],
  "description": "An object that represents the outlier detection for a virtual node's listener.",
  "$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-outlier-detection-structure.json",
  "name": "OutlierDetection"
}