eventnotification create

Prev Next

This command creates a definition of an event notification to publish events to an event broker.

Usage

eventnotification create --name NAME
                         --view-id ID
                         --broker-id ID
                         --topic TOPIC
                         --triggers EVENTS
                         [--prefix-filter FILTER_STRING]
                         [--suffix-filter FILTER_STRING]

Required Parameters

--name NAME

A unique name for the new event notification.

--view-id ID

The ID of the view for which event will be published.

The view must have S3 protocol enabled and be controlled with S3 Native security flavor.

--broker-id ID

The ID of the event broker to which events will be published. The event broker must be defined on the VAST cluster.

--topic TOPIC

The name of the topic to which to publish events.

--triggers EVENTS

Specify a comma-separated list of events for which you want to send notifications. Valid keywords for EVENTS include:

  • Object creation events:

    • S3_OBJECT_CREATED_PUT - Creation of an S3 object by a PUT request.

    • S3_OBJECT_CREATED_POST - Creation of an S3 object by a POST request.

    • S3_OBJECT_CREATED_COPY - Creation of an S3 object by copying an existing object.

    • S3_OBJECT_CREATED_COMPLETE_MULTIPART_UPLOAD - Creation of an S3 object as a result of a multi-part upload.

    • S3_OBJECT_CREATED_ALL - Any S3 object creation.

  • Object tagging events:

    • S3_OBJECT_TAGGING_PUT - Adding an S3 tag to an object.

    • S3_OBJECT_TAGGING_DELETE - Removing an S3 tag from an object.

    • S3_OBJECT_TAGGING_ALL - Any S3 object tagging operation.

  • Object deletion events:

    • S3_OBJECT_REMOVED_DELETE - Deletion of an S3 object by the S3 DELETE operation.

    • S3_OBJECT_REMOVED_DELETE_MARKER_CREATED - Creation of a delete marker for a versioned S3 object.

    • S3_OBJECT_REMOVED_ALL - Any S3 object deletion.

For example: --triggers S3_OBJECT_CREATED_PUT,S3-OBJECT_REMOVED_ALL

Options

--prefix-filter FILTER_STRING

Sends notifications only for those events that have an object key prefix matching the filter string.

For example: --prefix-filter mydocs/

--suffix-filter FILTER_STRING

Sends notifications only for those events that have an object key prefix matching the filter string.

For example: --suffix-filter .txt

Example

To send an event notification each time when a new object is created in the ABC folder on view 12:

vcli: admin> eventnotification create --name ev --view-id 12 --kafka-broker 1 --triggers S3_OBJECT_CREATED_ALL