docs/source/monitoring/bucket-notifications/bucket-notifications.rst

Bucket Notifications

minio

Table of Contents

MinIO bucket notifications allow administrators to send notifications to supported external services on certain object or bucket events. MinIO supports bucket and object-level S3 events similar to the Amazon S3 Event Notifications <NotificationHowTo.html>.

MinIO bucket notifications are available only with minio server deployments. MinIO Gateway <minio-gateway> does not support bucket notifications.

Supported Notification Targets

MinIO supports publishing event notifications to the following targets:

Target	Description
AMQP (RabbitMQ)	Publish notifications to an AMQP service such as RabbitMQ. See minio-bucket-notifications-publish-amqp for a tutorial.
MQTT	Publish notifications to an MQTT service. See minio-bucket-notifications-publish-mqtt for a tutorial.
NATS	Publish notifications to a NATS service. See minio-bucket-notifications-publish-nats for a tutorial.
NSQ	Publish notifications to a NSQ service. See minio-bucket-notifications-publish-nsq for a tutorial
Elasticsearch	Publish notifications to a Elasticsearch service. See minio-bucket-notifications-publish-elasticsearch for a tutorial.
Kafka	Publish notifications to a Kafka service. See minio-bucket-notifications-publish-kafka for a tutorial.
MySQL	Publish notifications to a MySQL service. See minio-bucket-notifications-publish-mysql for a tutorial.
PostgreSQL	Publish notifications to a PostgreSQL service. See minio-bucket-notifications-publish-postgresql for a tutorial.
Redis	Publish notifications to a Redis service. See minio-bucket-notifications-publish-redis for a tutorial.
webhook	Publish notifications to a Webhook service. See minio-bucket-notifications-publish-webhook for a tutorial.

Supported S3 Event Types

MinIO bucket notifications are compatible with Amazon S3 Event Notifications <NotificationHowTo.html>. This section lists all supported events.

Object Events

MinIO supports triggering notifications on the following S3 object events:

s3:ObjectAccessed:Get

s3:ObjectAccessed:GetLegalHold

s3:ObjectAccessed:GetRetention

s3:ObjectAccessed:Head

s3:ObjectCreated:CompleteMultipartUpload

s3:ObjectCreated:Copy

s3:ObjectCreated:DeleteTagging

s3:ObjectCreated:Post

s3:ObjectCreated:Put

s3:ObjectCreated:PutLegalHold

s3:ObjectCreated:PutRetention

s3:ObjectCreated:PutTagging

s3:ObjectRemoved:Delete

s3:ObjectRemoved:DeleteMarkerCreated

Specify the wildcard * character to select all events related to a prefix:

s3:ObjectAccessed:*

Selects all s3:ObjectAccessed-prefixed events.

s3:ObjectCreated:*

Selects all s3:ObjectCreated-prefixed events.

s3:ObjectRemoved:*

Selects all s3:ObjectRemoved-prefixed events.

Replication Events

MinIO supports triggering notifications on the following S3 replication events:

s3:Replication:OperationCompletedReplication

s3:Replication:OperationFailedReplication

s3:Replication:OperationMissedThreshold

s3:Replication:OperationNotTracked

s3:Replication:OperationReplicatedAfterThreshold

Specify the wildcard * character to select all s3:Replication events:

s3:Replication:*

ILM Transition Events

MinIO supports triggering notifications on the following S3 ILM transition events:

s3:ObjectRestore:Post

s3:ObjectRestore:Completed

s3:ObjectTransition:Failed

s3:ObjectTransition:Complete

Specify the wildcard * character to select all events related to a prefix:

s3:ObjectTransition:*

Selects all s3:ObjectTransition-prefixed events.

s3:ObjectRestore:*

Selects all s3:ObjectRestore-prefixed events.

Global Events

MinIO supports triggering notifications on the following global events. You can only listen to these events through the ListenNotification <golang-client-api-reference.html#ListenNotification> API:

s3:BucketCreated

s3:BucketRemoved

/monitoring/bucket-notifications/publish-events-to-amqp /monitoring/bucket-notifications/publish-events-to-mqtt /monitoring/bucket-notifications/publish-events-to-nats /monitoring/bucket-notifications/publish-events-to-nsq /monitoring/bucket-notifications/publish-events-to-elasticsearch /monitoring/bucket-notifications/publish-events-to-kafka /monitoring/bucket-notifications/publish-events-to-mysql /monitoring/bucket-notifications/publish-events-to-postgresql /monitoring/bucket-notifications/publish-events-to-redis /monitoring/bucket-notifications/publish-events-to-webhook