Trigger for Object Storage that invokes a Cloud Functions function

A trigger for Object Storage runs a Cloud Functions function when a specific event occurs with a Object Storage object. The trigger must be in the same cloud as the bucket whose events it is subscribed to.

A trigger for Object Storage needs a service account to call the function.

For more information about creating a trigger for Object Storage, see Creating a trigger for Object Storage that invokes a Cloud Functions function.

Events for setting up a triggerEvents for setting up a trigger

Events with bucket objects that can be tracked using a trigger:

• Creating an object.
• Editing an object ACL.
• Deleting an object.

Filtering events by objectFiltering events by object

Events are filtered using prefixes and suffixes for an object key:

• The prefix is the part of the object key that contains the beginning of the object key.
• The suffix is the part of the object key that contains the end of the object key.

Prefixes and suffixes can be of any length. When using a prefix and suffix at the same time, filtering is based on the logical AND: for the trigger to work, the object key must match both the prefix and suffix.

BatchingBatching

Batching settings allow you to send multiple events to a function at the same time. They set a top limit on the size of an event group and its accumulation time. For example, if the size of an event group is 3, the function can receive groups that contain from 1 to 3 events.

Roles required for the proper operation of a trigger for Object StorageRoles required for the proper operation of a trigger for Object Storage

• To create a trigger, you need a permission for the service account under which the trigger executes the operation. This permission comes with the iam.serviceAccounts.user and editor roles or higher.
• For the trigger to fire, the service account needs the functions.functionInvoker role for the folder containing the function called by the trigger.

Read more about access management.

Object Storage trigger message formatObject Storage trigger message format

After the trigger is activated, it sends the following message to the function:

{
  "messages": [
    {
      "event_metadata": {
        "event_id": "bb1dd06d-a82c-49b4-af98-d8e0********",
        "event_type": "yandex.cloud.events.storage.ObjectDelete",
        "created_at": "2019-12-19T14:17:47.847365Z",
        "tracing_context": {
          "trace_id": "dd52ace7********",
          "span_id": "",
          "parent_span_id": ""
        },
        "cloud_id": "b1gvlrnlei4l********",
        "folder_id": "b1g88tflru0e********"
      },
      "details": {
        "bucket_id": "s3-for-trigger",
        "object_id": "dev/0_15a775_972dbde4_orig12.jpg"
      }
    }
  ]
}

See alsoSee also

• Trigger for Object Storage that invokes a Serverless Containers container
• Trigger for Object Storage that sends messages to WebSocket connections