mc event add

Syntax

The mc event add command adds event notification triggers to a bucket.

MinIO automatically sends triggered events to the configured notification target.

The following command creates a new event notification trigger for all PUT and DELETE operations for the mydata bucket on the myminio MinIO deployment:

mc event add --event "put,delete" myminio/mydata arn:aws:sqs::primary:target

The specified ARN corresponds to a configured bucket notification target on the myminio deployment.

The command has the following syntax:

mc [GLOBALFLAGS] event add \
                 [--event "string"]  \
                 [--ignore-existing] \
                 [--prefix "string"] \
                 [--suffix "string"] \
                 ALIAS               \
                 ARN
  • Brackets [] indicate optional parameters.

  • Parameters sharing a line are mutually dependent.

  • Parameters seperated using the pipe | operator are mutually exclusive.

Copy the example to a text editor and modify as-needed before running the command in the terminal/shell.

Parameters

ALIAS

Required The MinIO alias and bucket to which the command adds the new event notification. For example:

mc event add play/mybucket
ARN

Required The Amazon Resource Name (ARN) of the notification target.

The MinIO server outputs an ARN for each configured notification target at server startup. See Bucket Notifications for more information.

--event

Optional The event(s) for which MinIO generates bucket notifications.

Supports the following values:

  • put

  • get

  • delete

Specify multiple value using a comma , delimiter.

Defaults to put,delete,get.

See Supported Bucket Events for a detailed list of S3 events associated to each of the supported values.

ignore-existing, p

Optional Directs MinIO to ignore applying the specified event triggers if an existing matching trigger exists.

--prefix

Optional The bucket prefix in which the specified --event can trigger a bucket notification.

For example, given a ALIAS of play/mybucket and a --prefix of photos, only events in play/mybucket/photos trigger bucket notifications.

Omit to trigger the event for all prefixes and objects in the bucket.

--suffix

Optional The bucket suffix in which the specified --event can trigger a bucket notification.

For example, given a ALIAS of play/mybucket and a --suffix of .jpg, only events in play/mybucket/*.jpg trigger bucket notifications.

Omit to trigger the event for all objects regardless of suffix.

Global Flags

--debug
Optional

Enables verbose output to the console.

For example:

mc --debug COMMAND
--config-dir
Optional

The path to a JSON formatted configuration file that mc uses for storing data. See Configuration File for more information on how mc uses the configuration file.

--JSON
Optional

Enables JSON lines formatted output to the console.

For example:

mc --JSON COMMAND
--no-color
Optional

Disables the built-in color theme for console output. Useful for dumb terminals.

--quiet
Optional

Suppresses console output.

--insecure
Optional

Disables TLS/SSL certificate verification. Allows TLS connectivity to servers with invalid certificates. Exercise caution when using this option against untrusted S3 hosts.

--version
Optional

Displays the current version of mc.

--help
Optional

Displays a summary of command usage on the terminal.

Examples

Add an Event Notification to a Bucket

The following command adds a new event notification trigger for all S3 PUT, GET, and DELETE operations on a bucket. The command assumes the MinIO deployment has at least one configured bucket notification target:

mc event add myminio/mydata arn:minio:sqs::primary:webhook
mc event add ALIAS ARN
  • Replace ALIAS with the alias of the MinIO deployment and the bucket on which to add the bucket notification event. For example:

    myminio/mydata

  • Replace ARN with the notification target ARN.

Behavior

Supported Bucket Events

The following table lists the supported mc event add values and their corresponding S3 events:

Supported Value

Corresponding S3 Events

put

get

delete

replica

ilm

For more complete documentation on the listed S3 events, see S3 Supported Event Types.

S3 Compatibility

The mc commandline tool is built for compatibility with the AWS S3 API and is tested MinIO and AWS S3 for expected functionality and behavior.

MinIO provides no guarantees for other S3-compatible services, as their S3 API implementation is unknown and therefore unsupported. While mc commands may work as documented, any such usage is at your own risk.