AWS Cloud Map

Managed service registry with API and DNS-based discovery.

Provider: aws
Kind: Coordination service
Category: Operations
Official docs: https://docs.aws.amazon.com/cloud-map/latest/dg/what-is-cloud-map.html

Properties · 2 set by this component

property	type	values	required	kind default	this component
consensus	enum	none \| raft \| paxos \| zab	no	none	inherited
discoveryMethod · component property	enum	api \| dns-private \| dns-public	no	—	inherited
healthCheckProvider · component property	enum	route53 \| third-party	no	—	inherited
healthChecking · component property	boolean	—	no	false	inherited
managed	boolean	—	no	false	▸ true
nodes	integer	—	no	—	inherited
replicated	boolean	—	no	false	inherited
role	enum	metadata \| lock \| discovery \| placement \| sharding \| leader-election \| config	yes	—	▸ discovery
servesOnlyHealthyInstances · component property	boolean	—	no	true	inherited

Rules that apply · 2

Every rule whose selector covers this component's kind or its category. Whether a rule fires depends on the design: its properties, its edges and its groups.

Shared dependency without redundancyerror

shared-dependency-without-redundancy

The design requires redundant discovery, but this DNS or coordination service, which everything depends on, runs on a single provider or a single replica. Its failure is the whole system's failure.

— all of these hold:
— the design requirement `availability.discoveryRedundant` is true
— any of these hold:
— the node's `redundantProviders` is false
— the node's `replicated` is false

Stateful engine pinned to a single zoneerror

stateful-engine-pinned-to-single-zone

A matching engine, coordination service or event store living in exactly one availability zone, with no failover and no replication, is lost with that zone. Everything that depends on it stops with it.

— all of these hold:
— the node sits inside exactly 1 availability-zone group
— any of these hold:
— the node's `failover` is "none"
— the node's `replicated` is false
— the node's `replication` is "none"

Use it in a design

nodes:
  - { id: "cloud-map", component: "aws-cloud-map" }

Other Coordination service products · 17

Source

1# yaml-language-server: $schema=../../schema/component.schema.json
2# AWS Cloud Map: fully managed service registry mapping logical names to backend resources.
3# "What Is AWS Cloud Map?": a namespace fixes the discovery method (DiscoverInstances API, private DNS or
4# public DNS), health checking is optional per service, and only healthy instances are returned when it is on.
5schemaVersion: "1"
6type: "component"
7id: "aws-cloud-map"
8kind: "coordination-service"
9provider: "aws"
10docs: "https://docs.aws.amazon.com/cloud-map/latest/dg/what-is-cloud-map.html"
11defaults:
12  managed: true
13  role: "discovery"
14properties:
15  discoveryMethod:
16    type: "enum"
17    values: ["api", "dns-private", "dns-public"]
18  healthChecking:
19    type: "boolean"
20    default: false
21  servesOnlyHealthyInstances:
22    type: "boolean"
23    default: true
24  healthCheckProvider:
25    type: "enum"
26    values: ["route53", "third-party"]

The same page as markdown, for an agent: /catalogue/components/aws-cloud-map.md