Amazon Cloud Map · JSON Structure

Cloud Map Http Instance Summary Structure

Represents a summary of a discovered service instance.

Type: object Properties: 5
Cloud MapService DiscoveryMicroservicesDNS

HttpInstanceSummary is a JSON Structure definition published by Amazon Cloud Map, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

InstanceId NamespaceName ServiceName HealthStatus Attributes

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

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cloud-map/refs/heads/main/json-structure/cloud-map-http-instance-summary-structure.json",
  "name": "HttpInstanceSummary",
  "description": "Represents a summary of a discovered service instance.",
  "type": "object",
  "properties": {
    "InstanceId": {
      "type": "string",
      "description": "The ID of an instance.",
      "example": "i-1234567890abcdef0"
    },
    "NamespaceName": {
      "type": "string",
      "description": "The HttpName name of the namespace.",
      "example": "production.internal"
    },
    "ServiceName": {
      "type": "string",
      "description": "The name of the service.",
      "example": "payment-service"
    },
    "HealthStatus": {
      "type": "string",
      "enum": [
        "HEALTHY",
        "UNHEALTHY",
        "UNKNOWN"
      ],
      "description": "If you configured health checking in the service, the current health status of the service's instances."
    },
    "Attributes": {
      "type": "object",
      "description": "Custom attributes associated with the instance."
    }
  }
}