Creating a trigger for Object Storage that invokes Cloud Functions

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id.

If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To create a trigger that invokes a function, run this command:

yc serverless trigger create object-storage \
  --name <trigger_name> \
  --bucket-id <bucket_ID> \
  --prefix '<object_key_prefix>' \
  --suffix '<object_key_suffix>' \
  --events 'create-object','delete-object','update-object' \
  --batch-size <event_batch_size> \
  --batch-cutoff <maximum_timeout> \
  --invoke-function-id <function_ID> \
  --invoke-function-service-account-id <service_account_ID> \
  --retry-attempts <number_of_retry_attempts> \
  --retry-interval <interval_between_retry_attempts> \
  --dlq-queue-id <dead-letter_queue_ID> \
  --dlq-service-account-id <service_account_ID>

Where:

• --name: Trigger name.
• --bucket-id: Bucket ID.
• --prefix: Bucket object key prefix. This is an optional setting. It is used for filtering.
• --suffix: Bucket object key suffix. This is an optional setting. It is used for filtering.
• --events: Events that set off the trigger.

• --batch-size: Event batch size. This is an optional setting. The values may range from 1 to 10. The default value is 1.
• --batch-cutoff: Maximum wait time. This is an optional setting. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups events within the batch-cutoff period and sends them to the function. The number of events cannot exceed batch-size.

• --invoke-function-id: Function ID.
• --invoke-function-service-account-id: ID of the service account with permissions to invoke the function.
• --retry-attempts: Number of invocation retries before the trigger sends a message to the dead-letter queue. This is an optional setting. The values may range from 1 to 5. The default value is 1.
• --retry-interval: Time to wait before retrying the function if it fails. This is an optional setting. The values may range from 10 to 60 seconds. The default value is 10 seconds.
• --dlq-queue-id: Dead-letter queue ID. This is an optional setting.
• --dlq-service-account-id: ID of the service account with write permissions for the dead-letter queue. This is an optional setting.

Result:

id: a1s92agr8mpg********
folder_id: b1g88tflru0e********
created_at: "2019-12-18T09:47:50.079103Z"
name: os-trigger
rule:
  object_storage:
    event_type:
    - OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT
    - OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT
    - OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT
    bucket_id: s3-for-trigger
    prefix: dev
    suffix: 12.jpg
    batch_settings:
      size: "3"
      cutoff: 20s
    invoke_function:
      function_id: d4eofc7n0m03********
      function_tag: $latest
      service_account_id: aje3932acd0c********
      retry_settings:
        retry_attempts: "1"
        interval: 10s
      dead_letter_queue:
        queue-id: yrn:yc:ymq:ru-central1:aoek49ghmknn********:dlq
        service-account-id: aje3932acd0c********
status: ACTIVE

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the guides on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To manage infrastructure using Terraform under a service account or user accounts (a Yandex account, a federated account, or a local user), authenticate using the appropriate method.

To create a trigger for Object Storage:

1. In the Terraform configuration file, describe the resources you want to create:

   resource "yandex_serverless_triggers" "my_trigger" {
     name        = "<trigger_name>"
     description = "<trigger_description>"
     source {
       object_storage {
         bucket_id = "<bucket_ID>"
         prefix    = "<object_key_prefix>"
         suffix    = "<object_key_suffix>"
         event_type = [
           "OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT",
           "OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT",
           "OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT",
         ]
         batch_settings {
           max_count = "<max_number_of_events>"
           max_bytes = "<max_group_size_in_bytes>"
           cutoff    = "<maximum_wait_time>"
         }
       }
     }
     action {
       invoke_function {
         function_id        = "<function_ID>"
         service_account_id = "<service_account_ID>"
       }
       retry_policy {
         retry_attempts = "<number_of_retries>"
         interval       = "<interval_between_retries>"
       }
       dead_letter {
         dead_letter_queue {
           queue_arn          = "<Dead_Letter_Queue_ARN>"
           service_account_id = "<service_account_ID>"
         }
       }
     }
   }
   

   Where:

   • name: Trigger name. The name format is as follows:

     • Length: between 3 and 63 characters.
     • It can only contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • description: Trigger description. This is an optional parameter.

   • labels: Trigger labels in key:value format. This is an optional parameter.

   • source: Event source settings:

     • object_storage: Bucket settings:

       • bucket_id: Bucket ID.

       • prefix: Bucket object key prefix. This is an optional parameter. It is used for filtering.

       • suffix: Bucket object key suffix. This is an optional parameter. It is used for filtering.

       • event_type: List of events to set off the trigger. Specify at least one value:

         • OBJECT_STORAGE_EVENT_TYPE_CREATE_OBJECT: Creating a new object in a bucket.
         • OBJECT_STORAGE_EVENT_TYPE_UPDATE_OBJECT: Updating an object in a bucket.
         • OBJECT_STORAGE_EVENT_TYPE_DELETE_OBJECT: Deleting an object from a bucket.

       • batch_settings: Event grouping settings. This is an optional section.

         • cutoff: Maximum event grouping time. This is a required setting. After the specified time has passed, the trigger sends the event group, even if it is not complete.
         • max_count: Maximum number of events per group.
         • max_bytes: Maximum total size of events per group, in bytes.

         At least one of the parameters, max_count or max_bytes, must be greater than 0.

   • action: Target settings. You can specify this section multiple times so that the trigger calls multiple resources, including those of different types. There are limits on the maximum number of resources.

     • invoke_function: Function settings:

       • function_id: Function ID.
       • function_tag: Function version tag. This is an optional parameter. If it is not specified, the latest version of the function is called.
       • service_account_id: ID of the service account with permissions to invoke the function.

     • filter: Filtering events before sending them to the target. This is an optional section.

       • jq: jq template to filter events sent to the target. It not specified, all events reach the target.

     • transformer: Transforming events before sending them to the target. This is an optional section.

       • jq: jq template to transform events before sending them to the target. It omitted, no transformations apply to the events.

     • retry_policy: Repeated request settings. This is an optional section.

       • interval: Time interval before a retry attempt to send the event if the current attempt fails.
       • retry_attempts: Number of retry attempts before the trigger moves the event to the dead-letter queue.

     • dead_letter: Dead-letter queue settings. This is an optional section.

       • dead_letter_queue: Queue settings:

         • queue_arn: Queue ARN.
         • service_account_id: ID of the service account with permissions to write to the queue.
         • message_attributes: Attributes to add to each message in the queue, in key:value format. This is an optional parameter.

   For more on the properties of the yandex_serverless_triggers resource, see this provider guide.

   Configuration for the yandex_function_trigger resource

   resource "yandex_function_trigger" "my_trigger" {
     name        = "<trigger_name>"
     description = "<trigger_description>"
     function {
       id                 = "<function_ID>"
       service_account_id = "<service_account_ID>"
       retry_attempts     = "<number_of_retry_attempts>"
       retry_interval     = "<time_between_retry_attempts>"
     }
     object_storage {
       bucket_id    = "<bucket_ID>"
       prefix       = "<object_key_prefix>"
       suffix       = "<object_key_suffix>"
       create       = true
       update       = true
       delete       = true
       batch_cutoff = "<maximum_wait_time>"
       batch_size   = "<event_batch_size>"
     }
     dlq {
       queue_id           = "<dead-letter_queue_ID>"
       service_account_id = "<service_account_ID>"
     }
   }
   

   Where:

   • name: Trigger name. Follow these naming requirements:

     • Length: between 3 and 63 characters.
     • It can only contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • description: Trigger description.

   • function: Function settings:

     • id: Function ID.
     • service_account_id: ID of the service account with permissions to invoke the function.
     • retry_attempts: Number of invocation retries before the trigger sends a message to the dead-letter queue. This is an optional setting. The values may range from 1 to 5. The default value is 1.
     • retry_interval: Time to wait before retrying the function if it fails. This is an optional setting. The values may range from 10 to 60 seconds. The default value is 10 seconds.

   • object_storage: Trigger settings:

     • bucket_id: Bucket ID.

     • prefix: Bucket object key prefix. This is an optional setting. It is used for filtering.

     • suffix: Bucket object key suffix. This is an optional setting. It is used for filtering.

     • Events that set off the trigger:

       • create: Trigger will invoke the function when a new object is created in the storage. It can either be true or false.
       • update: Trigger will invoke the function when an object is updated in the storage. It can either be true or false.
       • delete: Trigger will invoke the function when an object is deleted from the storage. It can either be true or false.
     • batch_cutoff: Maximum wait time. This is an optional setting. The values may range from 1 to 60 seconds. The default value is 1 second. The trigger groups events within the batch-cutoff period and sends them to the function. The number of events cannot exceed batch-size.
     • batch_size: Event batch size. This is an optional setting. The values may range from 1 to 10. The default value is 1.

   • dlq: Dead-letter queue settings:
     • queue_id: Dead-letter queue ID.
     • service_account_id: ID of the service account with write permissions for the dead-letter queue.

   For more on the properties of the yandex_function_trigger resource, see this provider guide.

2. Create the resources:

   1. In the terminal, navigate to the configuration file directory.

   2. Make sure the configuration is correct using this command:

      terraform validate
      

      If the configuration is valid, you will get this message:

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

   5. Type yes and press Enter to confirm the changes.

   Terraform will create all the required resources. You can check the new resources using the management console or this CLI command:

   yc serverless trigger list
   

To create a trigger for Object Storage, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.