Skip to main content

Pubsub

PubSub

Defines the high-level intent for a managed messaging topic.

Establishes an asynchronous, event-driven communication channel between decoupled platform components. Translates into the underlying topic infrastructure and manages core operational parameters including message retention windows, customer-managed encryption keys (CMEK), and geographic storage persistence boundaries.

PropertyTypeDescription
apiVersionstring
kindstring
metadatamap
specSpec

Spec

Contains the user-defined configuration for the Pub/Sub topic. Encapsulates configuration parameters for data encryption, regional storage constraints, message lifecycle retention, and event-driven notification routing.

PropertyTypeDescription
descriptionstringThis description is optional but will drastically improve the understand of the AI assistant about the structural elements of the organization
encryptedboolIf set to true, messages published to this topic will be encrypted with a customer-managed encryption key (CMEK). Triggers the provisioning of a dedicated Key Management Service (KMS) key ring and crypto key, and associates it with the topic for envelop encryption.
allowedPersistenceRegionslist of stringA list of GCP region codes where the platform is allowed to store this topic's messages. Restricts the geographic locations where message data can physical reside by enforcing a message storage policy on the topic.
messageRetentionDurationSecondsint64The minimum duration to retain unacknowledged messages in the topic's backlog, specified in seconds. Translates into the message retention duration metric enforced by the managed topic backlog.
notificationslist of EventArcNotificationTargetDefines a list of notification targets to be triggered by events on this Pub/Sub topic. Intended to provision event routing infrastructure (e.g., Eventarc triggers) to dispatch messages to specific downstream destinations. This functionality is defined in the schema but not fully implemented.

EventArcNotificationTarget

Details the webhook destination for Eventarc triggers.

Directs where Pub/Sub or Audit Log events pushed by Eventarc should hit a deployed Cloud Run service.

PropertyTypeDescription
deploymentConfigstringThe name of the 'DeploymentConfig' manifest that defines the target service for the notification.
pathstringThe relative URL path on the target service where Eventarc should send the event payload.