Contact UsGet started

Updating a broker

Written by
Updated at November 26, 2024

Note

The broker is at the Preview stage.

You can change the name and description of a broker 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 the name of a broker

  1. In the management console, select the folder to update the broker name in.
  2. Select IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of the broker you need, 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 command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

Update the name of a broker:

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

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To update the name of a broker created using Terraform:

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

    Example 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 information about the yandex_iot_core_broker resource parameters in Terraform, see the relevant provider documentation.

  2. In the command line, change to the folder where you edited the configuration file.

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

    terraform validate

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

    Success! The configuration is valid.

  4. Run this command:

    terraform plan

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

  5. Apply the configuration changes:

    terraform apply

  6. Confirm the changes: type yes into the terminal and press Enter.

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

    yc iot broker list

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

Updating the description of a broker

To update the broker description:

  1. In the management console, select the folder to update the broker description in.
  2. Select IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of the broker you need, 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 command line interface 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 documentation on the Terraform website or mirror website.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To update the description of a broker created using Terraform:

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

    Example 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 information about the yandex_iot_core_broker resource parameters in Terraform, see the relevant provider documentation.

  2. In the command line, change to the folder where you edited the configuration file.

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

    terraform validate

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

    Success! The configuration is valid.

  4. Run this command:

    terraform plan

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

  5. Apply the configuration changes:

    terraform apply

  6. Confirm the changes: type yes into the terminal and press Enter.

    You can check the updated broker description in the management console or using 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 perform the following actions with broker labels:

Adding a label

  1. In the management console, select the folder to add the broker label to.
  2. Select IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of the broker you need, 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 command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

Add a label to a broker:

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

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To add a label to a broker created using Terraform:

  1. In the configuration file, describe the parameters of the resource to create:

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

    Here is an example of the 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 information about the yandex_iot_core_broker resource parameters in Terraform, see the relevant provider documentation.

  2. In the command line, change to the folder where you edited the configuration file.

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

    terraform validate

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

    Success! The configuration is valid.

  4. Run this command:

    terraform plan

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

  5. Apply the configuration changes:

    terraform apply

  6. Confirm the changes: type yes into the terminal and press Enter.

    You can verify 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 to update the broker label in.
  2. Select IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of the broker you need, 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 command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

Update a broker label:

Warning

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

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To update the label of a broker created using Terraform:

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

    Example 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 information about the yandex_iot_core_broker resource parameters in Terraform, see the relevant provider documentation.

  2. In the command line, change to the folder where you edited the configuration file.

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

    terraform validate

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

    Success! The configuration is valid.

  4. Run this command:

    terraform plan

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

  5. Apply the configuration changes:

    terraform apply

  6. Confirm the changes: type yes into the terminal and press Enter.

    You can verify 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 to delete the broker label from.
  2. Select IoT Core.
  3. In the left-hand panel, select Brokers.
  4. To the right of the name of the broker you need, 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 command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

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

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To delete the label of a broker created using Terraform:

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

    Example 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 information about the yandex_iot_core_broker resource parameters in Terraform, see the relevant provider documentation.

  2. In the command line, change to the folder where you edited the configuration file.

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

    terraform validate

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

    Success! The configuration is valid.

  4. Run this command:

    terraform plan

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

  5. Apply the configuration changes:

    terraform apply

  6. Confirm the changes: type yes into the terminal and press Enter.

    You can verify 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