---
id: "pubsub-topic"
type: "component"
kind: "pubsub-topic"
provider: "default"
category: "messaging"
url: "https://localhost:3000/catalogue/components/pubsub-topic"
---

# Generic Pub/Sub topic

Vendor-neutral Pub/Sub topic. Use when the real product is not in the catalogue; every rule for this kind still applies.

| | |
|---|---|
| Provider | [default](https://localhost:3000/catalogue?provider=default) |
| Kind | [Pub/Sub topic](https://localhost:3000/catalogue/kinds/pubsub-topic) |
| Category | Messaging |
| Official docs | not recorded |
| Generic? | Vendor-neutral: the kind itself |

## Properties

| property | type | values | required | default |
|---|---|---|---|---|
| `delivery` | enum | `at-most-once`, `at-least-once`, `exactly-once` | yes | — |
| `managed` | boolean | — | no | false |
| `ordering` | enum | `none`, `per-key` | no | "none" |
| `replay` | boolean | — | no | false |
| `topicPerEventType` (advanced) | boolean | — | no | true |

## Rules that apply · 1

### Pub/Sub topic where replay is required `pubsub-replay-required` (error)

- Page: https://localhost:3000/catalogue/rules/pubsub-replay-required.md
- Why: The design declares that consumers must be able to replay history. A fan-out topic that does not retain messages cannot deliver that.
- Applies to: every node of kind pubsub-topic
- Message: Topic '{{node.id}}' cannot replay messages, but the design requires replay. Use a stream or a replayable queue.

It fires when:

- all of these hold:
  - the design requirement `messaging.replay` is true
  - the node's `replay` is false

## Other products of the same kind · 12

- [EventBridge](https://localhost:3000/catalogue/components/alibaba-eventbridge.md) `alibaba-eventbridge` — alibabacloud
- [Amazon EventBridge](https://localhost:3000/catalogue/components/aws-eventbridge.md) `aws-eventbridge` — aws
- [Amazon SNS](https://localhost:3000/catalogue/components/sns.md) `sns` — aws
- [Azure Event Grid](https://localhost:3000/catalogue/components/azure-event-grid.md) `azure-event-grid` — azure
- [Azure Event Grid MQTT Broker](https://localhost:3000/catalogue/components/azure-event-grid-mqtt.md) `azure-event-grid-mqtt` — azure
- [Eclipse Mosquitto](https://localhost:3000/catalogue/components/mosquitto.md) `mosquitto` — default
- [MQTT broker](https://localhost:3000/catalogue/components/mqtt-broker.md) `mqtt-broker` — default
- [NanoMQ](https://localhost:3000/catalogue/components/nanomq.md) `nanomq` — default
- [Redis Pub/Sub](https://localhost:3000/catalogue/components/redis-pubsub.md) `redis-pubsub` — default
- [Eventarc](https://localhost:3000/catalogue/components/google-eventarc.md) `google-eventarc` — gcp
- [Google Cloud Pub/Sub](https://localhost:3000/catalogue/components/google-pubsub.md) `google-pubsub` — gcp
- [OCI Events](https://localhost:3000/catalogue/components/oci-events.md) `oci-events` — oci

## Use it in a design

```yaml
nodes:
  - { id: "pubsub-topic", component: "pubsub-topic" }
```

## Source (`component` YAML, verbatim)

```yaml
# yaml-language-server: $schema=../../schema/component.schema.json
# The vendor-neutral Pub/Sub topic: the kind itself, with no product behind it. It sets no
# defaults and adds no properties, so every required kind property stays required on the node.
schemaVersion: "1"
type: "component"
id: "pubsub-topic"
kind: "pubsub-topic"
provider: "default"
```

Human page: https://localhost:3000/catalogue/components/pubsub-topic