Editing a connector

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 connector parameters:

   yc serverless eventrouter connector update --help
   

2. Get a list of connectors:

   yc serverless eventrouter connector list
   

   Result:

   +----------------------+-----------------------+----------------------+----------------------+---------+---------------------+
   |          ID          |         NAME          |        BUS ID        |      FOLDER ID       | STATUS  | DELETION PROTECTION |
   +----------------------+-----------------------+----------------------+----------------------+---------+---------------------+
   | f66g4h59ih2g******** | connector-my-ydb-flow | f66qn4p7uk6p******** | b1g681qpemb4******** | STOPPED | true                |
   | f66g6jcnc5no******** | yds-via-cli           | f66qn4p7uk6p******** | b1g681qpemb4******** | RUNNING | false               |
   | f66jfhcg1u71******** | mq-via-terraform      | f66qn4p7uk6p******** | b1g681qpemb4******** | RUNNING | false               |
   +----------------------+-----------------------+----------------------+----------------------+---------+---------------------+
   

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

   yc serverless eventrouter connector update \
     --name <connector_name> \
     --new-name <new_connector_name>
   

   Result:

   id: f66g4h59ih2g********
   bus_id: f66qn4p7uk6p********
   folder_id: b1g681qpemb4********
   cloud_id: b1gia87mbaom********
   created_at: "2025-02-20T15:30:05.248052Z"
   name: renamed-ydb
   description: consumer-one
   labels:
     owner: admin
     version: beta
   source:
     data_stream:
       database: /ru-central1/b1gia87mbaom********/etntd0p5tauu********
       stream_name: my-ydb-flow
       consumer: consumer-one
       service_account_id: ajelprpohp7r********
   deletion_protection: true
   status: STOPPED
   

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 edit a connector:

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

   Example of a connector description in the Terraform configuration file:

   resource "yandex_serverless_eventrouter_connector" "example_connector" {
     bus_id              = "<bus_ID>"
     name                = "<connector_name>"
     description         = "<connector_description>"
     deletion_protection = <true|false>
   
     labels = {
       <key_1> = "<value_1>"
       <key_2> = "<value_2>"
       ...
       <key_n> = "<value_n>"
     }
     ...
   }
   

   For more information about yandex_serverless_eventrouter_connector 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 connector list
   

To edit a connector, use the Update REST API method for the Connector resource or the Connector/Update gRPC API call.