Discuss with expertTry it for free
© 2026 Direct Cursus Technology L.L.C.

Updating a broker

Written by
Updated at August 10, 2026
View in Markdown

Warning

Yandex IoT Core is no longer available to new users.

Current users can create resources until November 1, 2026. Afterwards, the service will go read-only and cease to operate on December 1, 2026. For more information on the timing and procedure, see Service shutdown.

Note

The broker is at the Preview stage.

You can update a broker name or description, as well as manage broker labels.

To access a broker, use its unique ID or name. For info on how to get the unique broker ID or name, see Getting information about a broker.

Updating a broker name

  1. In the management console, select the folder where you want to update the broker name.
  2. Navigate to IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of your broker, click and select Edit from the drop-down list.
  5. Edit the Name field.
  6. Click Save.

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.

Update the broker name:

yc iot broker update my-broker --new-name test-broker

Result:

id: b91ki3851h**********
folder_id: aoek49ghmk**********
created_at: "2019-05-28T11:29:42.420Z"
name: test-broker

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 update the name of a broker created with Terraform:

  1. Open the Terraform configuration file and edit the name parameter value in the broker description.

    Here is an example of a broker description in the Terraform configuration:

    resource "yandex_iot_core_broker" "my_broker" {
  name        = "test-broker"
  description = "test broker for terraform provider documentation"
  }
...
}

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

  2. In the terminal, navigate to the directory where you edited the configuration file.

  3. Make sure the configuration file is correct using this command:

    terraform validate

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

    Success! The configuration is valid.

  4. 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.

  5. Apply the configuration changes:

    terraform apply

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

    You can check the updated broker name using the management console or this CLI command:

    yc iot broker list

To update a broker name, use the update REST API method for the Broker resource or the BrokerService/Update gRPC API call.

Updating a broker description

To update a broker description:

  1. In the management console, select the folder where you want to update the broker description.
  2. Navigate to IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of your broker, click and select Edit from the drop-down list.
  5. Edit the Description field.
  6. Click Save.

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

Update the broker description:

yc iot broker update my-broker --description "My test broker."

Result:

id: b91ki3851h**********
folder_id: aoek49ghmk**********
created_at: "2019-05-28T11:29:42.420Z"
name: my-broker
description: My test broker.
labels:
  test_label: my_broker_label

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 update the description of a broker created with Terraform:

  1. Open the Terraform configuration file and edit the description parameter value in the broker description.

    Here is an example of a broker description in the Terraform configuration:

    resource "yandex_iot_core_broker" "my_broker" {
  name        = "test-broker"
  description = "test broker for terraform provider documentation"
  }
...
}

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

  2. In the terminal, navigate to the directory where you edited the configuration file.

  3. Make sure the configuration file is correct using this command:

    terraform validate

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

    Success! The configuration is valid.

  4. 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.

  5. Apply the configuration changes:

    terraform apply

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

    You can check the updated broker description using the management console or this CLI command:

    yc iot broker get <broker_name>

To update a broker description, use the update REST API method for the Broker resource or the BrokerService/Update gRPC API call.

Managing broker labels

You can manage broker labels in the following ways:

Adding a label

  1. In the management console, select the folder where you want to add a broker label.
  2. Navigate to IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of your broker, click and select Edit from the drop-down list.
  5. Fill in the Key and Value fields and click Add label.
  6. Click Save.

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.

Add a broker label:

yc iot broker add-labels my-broker --labels new_label=test_label

Result:

id: b91ki3851h**********
folder_id: aoek49ghmk**********
created_at: "2019-05-28T11:29:42.420Z"
name: my-broker
labels:
  new_label: test_label

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 add a label to a broker created with Terraform:

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

    • yandex_iot_core_broker: Broker settings:

      • name: Broker name.
      • description: Broker description.
      • labels: Broker labels in key:value format.

    Here is an example of a resource structure in the configuration file:

    resource "yandex_iot_core_broker" "my_broker" {
  name        = "test-broker"
  description = "test broker for terraform provider documentation"
  labels = {
    new-label = "test-label"
  }
...
}

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

  2. In the terminal, navigate to the directory where you edited the configuration file.

  3. Make sure the configuration file is correct using this command:

    terraform validate

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

    Success! The configuration is valid.

  4. 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.

  5. Apply the configuration changes:

    terraform apply

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

    You can check broker labels using the following CLI command:

    yc iot broker get <broker_name>

To add a label to a broker, use the update REST API method for the Broker resource or the BrokerService/Update gRPC API call.

Updating a label

  1. In the management console, select the folder where you want to update a broker label.
  2. Navigate to IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of your broker, click and select Edit from the drop-down list.
  5. Edit the Key and Value fields.
  6. Click Save.

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.

Update a broker label:

Warning

The existing labels (labels) will be completely overwritten by the ones you provide in your request.

yc iot broker update my-broker --labels test_label=my_broker_label

Result:

id: b91ki3851h**********
folder_id: aoek49ghmk**********
created_at: "2019-05-28T11:29:42.420Z"
name: my-broker
labels:
  test_label: my_broker_label

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 update a label of a broker created with Terraform:

  1. Open the Terraform configuration file and edit the label value in the labels section of the broker description.

    Here is an example of a broker description in the Terraform configuration:

    resource "yandex_iot_core_broker" "my_broker" {
  name        = "test-broker"
  description = "test broker for terraform provider documentation"
  labels = {
    test-label = "my-broker-label"
  }
...
}

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

  2. In the terminal, navigate to the directory where you edited the configuration file.

  3. Make sure the configuration file is correct using this command:

    terraform validate

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

    Success! The configuration is valid.

  4. 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.

  5. Apply the configuration changes:

    terraform apply

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

    You can check broker labels using the following CLI command:

    yc iot broker get <broker_name>

To update a broker label, use the update REST API method for the Broker resource or the BrokerService/Update gRPC API call.

Deleting a label

  1. In the management console, select the folder where you want to delete a broker label.
  2. Navigate to IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of your broker, click and select Edit from the drop-down list.
  5. To the right of the label to delete, click .
  6. Click Save.

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.

Delete a broker label:

yc iot broker remove-labels my-broker --labels new_label

Result:

id: b91ki3851h**********
folder_id: aoek49ghmk**********
created_at: "2019-05-28T11:29:42.420Z"
name: my-broker

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 delete a label of a broker created with Terraform:

  1. Open the Terraform configuration file and delete the label value from the labels section of the broker description. To delete all labels, delete the entire labels section.

    Here is an example of a broker description in the Terraform configuration:

    resource "yandex_iot_core_broker" "my_broker" {
  name        = "test-broker"
  description = "test broker for terraform provider documentation"
  labels = {
    test-label = "my-broker-label"
  }
...
}

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

  2. In the terminal, navigate to the directory where you edited the configuration file.

  3. Make sure the configuration file is correct using this command:

    terraform validate

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

    Success! The configuration is valid.

  4. 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.

  5. Apply the configuration changes:

    terraform apply

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

    You can check broker labels using the following CLI command:

    yc iot broker get <broker_name>

To delete a broker label, use the update REST API method for the Broker resource or the BrokerService/Update gRPC API call.

Previous
Creating a broker
Next
Deleting a broker