Updating a bus

If you do not have the Yandex Cloud (CLI) command line interface yet, install and initialize it.

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

1. View the description of the CLI command for editing bus parameters:

   yc serverless eventrouter bus update --help
   

2. Get a list of buses:

   yc serverless eventrouter bus list
   

   Result:

   +----------------------+------------------+----------------------+--------+---------------------+
   |          ID          |       NAME       |      FOLDER ID       | STATUS | DELETION PROTECTION |
   +----------------------+------------------+----------------------+--------+---------------------+
   | f6676a9ti657******** | my-new-bus-17    | b1g681qpemb4******** | ACTIVE | false               |
   | f66aevm4ithv******** | my-favourite-bus | b1g681qpemb4******** | ACTIVE | true                |
   | f66m2q222n92******** | my-bus-42        | b1g681qpemb4******** | ACTIVE | false               |
   +----------------------+------------------+----------------------+--------+---------------------+
   

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

   yc serverless eventrouter bus update \
     --name <bus_name> \
     --new-name <new_bus_name>
   

   Result:

   id: f66aevm4ithv********
   folder_id: b1g681qpemb4********
   cloud_id: b1gia87mbaom********
   created_at: "2025-02-13T12:36:59.497985Z"
   name: my-bus-43
   description: this is my bus
   labels:
     owner: admin
   deletion_protection: true
   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 documentation on the Terraform website or mirror website.

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

To update a bus:

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

   Example of a bus description in a Terraform configuration file:

   resource "yandex_serverless_eventrouter_bus" "example_bus" {
     name                = "my-bus"
     description         = "this is my bus"
     deletion_protection = true
   
     labels = {
       key1 = "value1"
       key2 = "value2"
     }
   }
   

   For more information about the yandex_serverless_eventrouter_bus resource parameters, see this Terraform article.

2. Apply the changes:

   1. In the terminal, change to the folder where you edited the configuration file.

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

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

      The terminal will display a list of resources with parameters. No changes are made at this step. If the configuration contains errors, Terraform will point them out.

   4. Apply the configuration changes:

      terraform apply
      

   5. Confirm the changes: type yes in the terminal and press Enter.

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

   yc serverless eventrouter bus list
   

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