Amazon Cloud Map · Schema

Service

Represents a Cloud Map service used for service discovery.

Cloud MapService DiscoveryMicroservicesDNS

Properties

Name Type Description
Id string The ID of the service.
Arn string The Amazon Resource Name (ARN) of the service.
Name string The name of the service.
NamespaceId string The ID of the namespace.
Description string The description of the service.
InstanceCount integer The number of instances that are currently associated with the service.
View JSON Schema on GitHub

JSON Schema

cloud-map-service-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cloud-map/refs/heads/main/json-schema/cloud-map-service-schema.json",
  "title": "Service",
  "description": "Represents a Cloud Map service used for service discovery.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "The ID of the service.",
      "example": "svc-abc12345"
    },
    "Arn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the service."
    },
    "Name": {
      "type": "string",
      "description": "The name of the service.",
      "example": "payment-service"
    },
    "NamespaceId": {
      "type": "string",
      "description": "The ID of the namespace."
    },
    "Description": {
      "type": "string",
      "description": "The description of the service."
    },
    "InstanceCount": {
      "type": "integer",
      "description": "The number of instances that are currently associated with the service."
    }
  }
}