Editing a rule

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.

1. View the description of the CLI command for updating rule parameters:

   yc serverless eventrouter rule update --help
   

2. Get a list of rules:

   yc serverless eventrouter rule list
   

   Result:

   +----------------------+-------+----------------------+----------------------+---------+---------------------+
   |          ID          | NAME  |        BUS ID        |      FOLDER ID       | TARGETS | DELETION PROTECTION |
   +----------------------+-------+----------------------+----------------------+---------+---------------------+
   | f66ir9eeie4e******** | rule1 | f662ctjn8vo6******** | b1geoelk7fld******** | Logging | false               |
   | f66q0kq19n2q******** | rule2 | f662ctjn8vv4******** | b1geoelk7fld******** | YMQ     | false               |
   +----------------------+-------+----------------------+----------------------+---------+---------------------+
   

3. In the command, specify the parameters to update, such as the rule name:

   yc serverless eventrouter rule update \
     --name <rule_name> \
     --new-name <new_rule_name>
   

   Result:

   id: f66aa46qtt1l********
   bus_id: f66epjc9llqt********
   folder_id: b1g681qpemb4********
   cloud_id: b1gia87mbaom********
   created_at: "2025-02-26T10:30:59.611601Z"
   name: renamed-rule
   labels:
     owner: admin
     version: beta
   targets:
     - ymq:
         queue_arn: yrn:yc:ymq:ru-central1:b1g681qpemb4********:dlq-42
         service_account_id: ajelprpohp7r********
       status: ENABLED
   status: ENABLED
   

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 relevant documentation on the Terraform website or its mirror.

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

To update a rule:

1. Open the Terraform configuration file and edit the part with the yandex_serverless_eventrouter_rule resource description.

   Example of a rule description in the Terraform configuration file:

   resource "yandex_serverless_eventrouter_rule" "example_rule" {
     bus_id      = "<rule_ID>"
     name        = "<rule_name>"
     description = "<rule_description>"
   
     labels = {
       <key_1> = "<value_1>"
       <key_2> = "<value_2>"
       ...
       <key_n> = "<value_n>"
     }
   
     jq_filter = "<jq_template>"
   
     ...
   }
   

   For more information about yandex_serverless_eventrouter_rule properties, see this provider guide.

2. Apply the changes:

   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 updates in the management console or using this CLI command:

   yc serverless eventrouter rule list
   

To update a rule, use the Update REST API method for the Rule resource or the Rule/Update gRPC API call.