Updating Apache Kafka® cluster settings

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the cluster name and description:

1. See the description of the CLI command for updating a cluster:

   yc managed-kafka cluster update --help
   

2. Run this command, specifying the new cluster name and description:

   yc managed-kafka cluster update <cluster_name_or_ID> \
     --new-name <new_cluster_name> \
     --description <new_cluster_description>
   

   To find out the cluster name or ID, get the list of clusters in the folder.

To update the cluster description:

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. Edit the description parameter in the Managed Service for Apache Kafka® cluster description:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     name        = "<cluster_name>"
     description = "<new_cluster_description>"
     ...
   }
   

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "name,description",
                 "name": "<cluster_name>",
                 "description": "<new_cluster_description>"
               }'
   

   Where:

   • updateMask: Comma-separated string of settings you want to update.

     Specify the relevant parameters:

     • name: To change the cluster name.
     • description: To change the cluster description.

   • name: New cluster name.

   • description: New cluster description.

   You can get the cluster ID with the list of clusters in the folder.

3. View the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService/Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "name",
                 "description"
               ]
             },
             "name": "<cluster_name>",
             "description": "<new_cluster_description>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Specify the relevant parameters:

     • name: To change the cluster name.
     • description: To change the cluster description.

   • name: New cluster name.

   • description: New cluster description.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the class and number of hosts:

1. Get information about the cluster:

   yc managed-kafka cluster list
   yc managed-kafka cluster get <cluster_name_or_ID>
   

2. See the description of the CLI command for updating a cluster:

   yc managed-kafka cluster update --help
   

3. To increase the number of broker hosts, run this command:

   yc managed-kafka cluster update <cluster_name_or_ID> --brokers-count <number>
   

4. To change the broker host class, run this command:

   yc managed-kafka cluster update <cluster_name_or_ID> --resource-preset <host_class>
   

To find out the cluster name or ID, get the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for Apache Kafka® cluster description, edit the brokers_count parameter value to increase the number of broker hosts:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     config {
       brokers_count = <number_of_broker_hosts>
       ...
     }
     ...
   }
   

3. In the Managed Service for Apache Kafka® cluster description, edit the resource_preset_id parameter value in the kafka.resources section to specify a new broker host class:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     kafka {
       resources {
         resource_preset_id = "<broker_host_class>"
         ...
       }
     }
   }
   

4. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

5. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Get the list of available host classes:

   1. Call the ResourcePreset.list method, e.g., via the following cURL request:

      curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/resourcePresets'
      

   2. Check the server response to make sure your request was successful.

3. Change the class and number of broker hosts as appropriate:

   1. Call the Cluster.update method, e.g., via the following cURL request:

      Warning

      The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

      curl \
          --request PATCH \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --header "Content-Type: application/json" \
          --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>' \
          --data '{
                    "updateMask": "configSpec.kafka.resources.resourcePresetId,configSpec.brokersCount",
                    "configSpec": {
                      "kafka": {
                        "resources": {
                          "resourcePresetId": "<broker_host_class_ID>"
                        }
                      },
                      "brokersCount": "<number_of_broker_hosts>"
                    }
                  }'
      

      Where:

      • updateMask: Comma-separated string of settings you want to update.

        Specify the relevant parameters:

        • configSpec.kafka.resources.resourcePresetId: To change the broker host class.
        • configSpec.brokersCount: To change the number of broker hosts.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

   2. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Get the list of available host classes:

   1. Call the ResourcePresetService/List method, e.g., via the following gRPCurl request:

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/resource_preset_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.kafka.v1.ResourcePresetService.List
      

   2. Check the server response to make sure your request was successful.

4. Change the host class as appropriate:

   1. Call the ClusterService/Update method, e.g., via the following gRPCurl request:

      Warning

      The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

      Format for listing settings

      "update_mask": {
          "paths": [
              "<setting_1>",
              "<setting_2>",
              ...
              "<setting_N>"
          ]
      }
      

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "cluster_id": "<cluster_ID>",
                "update_mask": {
                  "paths": [
                    "config_spec.kafka.resources.resource_preset_id",
                    "config_spec.brokers_count"
                  ]
                },
                "config_spec": {
                  "kafka": {
                    "resources": {
                      "resource_preset_id": "<broker_host_class_ID>"
                    }
                  },
                  "brokers_count": {
                    "value": "<number_of_broker_hosts>"
                  }
                }
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.kafka.v1.ClusterService.Update
      

      Where:

      • update_mask: List of settings you want to update as an array of strings (paths[]).

        Specify the relevant parameters:

        • config_spec.kafka.resources.resource_preset_id: To change the broker host class.
        • config_spec.brokers_count: To change the number of broker hosts.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

   2. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the class of ZooKeeper hosts:

1. Get information about the cluster:

   yc managed-kafka cluster list
   yc managed-kafka cluster get <cluster_name_or_ID>
   

2. See the description of the CLI command for updating a cluster:

   yc managed-kafka cluster update --help
   

3. To change the ZooKeeper host class, run this command:

   yc managed-kafka cluster update <cluster_name_or_ID> \
     --zookeeper-resource-preset <host_class>
   

To find out the cluster name or ID, get the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for Apache Kafka® cluster description, edit the resource_preset_id parameter value in the zookeeper.resources section to specify a new ZooKeeper host class:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     zookeeper {
       resources {
         resource_preset_id = "<ZooKeeper_host_class>"
         ...
       }
     }
    }
   

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Get the list of available host classes:

   1. Call the ResourcePreset.list method, e.g., via the following cURL request:

      curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/resourcePresets'
      

   2. Check the server response to make sure your request was successful.

3. Change the host class as appropriate:

   1. Call the Cluster.update method, e.g., via the following cURL request:

      Warning

      The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

      curl \
          --request PATCH \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --header "Content-Type: application/json" \
          --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>' \
          --data '{
                    "updateMask": "configSpec.zookeeper.resources.resourcePresetId",
                    "configSpec": {
                      "zookeeper": {
                        "resources": {
                          "resourcePresetId": "<ZooKeeper_host_class_ID>"
                        }
                      }
                    }
                  }'
      

      Where:

      • updateMask: Comma-separated string of settings you want to update.

        Specify the relevant parameters:

        • configSpec.zookeeper.resources.resourcePresetId: To change the ZooKeeper host class.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

   2. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Get the list of available host classes:

   1. Call the ResourcePresetService/List method, e.g., via the following gRPCurl request:

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/resource_preset_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.kafka.v1.ResourcePresetService.List
      

   2. Check the server response to make sure your request was successful.

4. Change the host class as appropriate:

   1. Call the ClusterService/Update method, e.g., via the following gRPCurl request:

      Warning

      The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

      Format for listing settings

      "update_mask": {
          "paths": [
              "<setting_1>",
              "<setting_2>",
              ...
              "<setting_N>"
          ]
      }
      

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "cluster_id": "<cluster_ID>",
                "update_mask": {
                  "paths": [
                    "config_spec.zookeeper.resources.resource_preset_id"
                  ]
                },
                "config_spec": {
                  "zookeeper": {
                    "resources": {
                      "resource_preset_id": "<ZooKeeper_host_class_ID>"
                    }
                  }
                }
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.kafka.v1.ClusterService.Update
      

      Where:

      • update_mask: List of settings you want to update as an array of strings (paths[]).

        Specify the relevant parameters:

        • config_spec.zookeeper.resources.resource_preset_id: To change the ZooKeeper host class.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

   2. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change the class of KRaft hosts:

1. Get information about the cluster:

   yc managed-kafka cluster list
   yc managed-kafka cluster get <cluster_name_or_ID>
   

2. See the description of the CLI command for updating a cluster:

   yc managed-kafka cluster update --help
   

3. To change the KRaft host class, run this command:

   yc managed-kafka cluster update <cluster_name_or_ID> \
     --controller-resource-preset <host_class>
   

To find out the cluster name or ID, get the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for Apache Kafka® cluster description, edit the resource_preset_id parameter value in the kraft.resources section to specify a new KRaft host class:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     kraft {
       resources {
         resource_preset_id = "<KRaft_host_class>"
         ...
       }
     }
    }
   

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Get the list of available host classes:

   1. Call the ResourcePreset.list method, e.g., via the following cURL request:

      curl \
          --request GET \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/resourcePresets'
      

   2. Check the server response to make sure your request was successful.

3. Change the host class as appropriate:

   1. Call the Cluster.update method, e.g., via the following cURL request:

      Warning

      The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

      curl \
          --request PATCH \
          --header "Authorization: Bearer $IAM_TOKEN" \
          --header "Content-Type: application/json" \
          --url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>' \
          --data '{
                    "updateMask": "configSpec.kraft.resources.resourcePresetId",
                    "configSpec": {
                      "kraft": {
                        "resources": {
                          "resourcePresetId": "<KRaft_host_class_ID>"
                        }
                      }
                    }
                  }'
      

      Where:

      • updateMask: Comma-separated string of settings you want to update.

        Specify the relevant parameters:

        • configSpec.kraft.resources.resourcePresetId: To change the KRaft host class.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

   2. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Get the list of available host classes:

   1. Call the ResourcePresetService/List method, e.g., via the following gRPCurl request:

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/resource_preset_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.kafka.v1.ResourcePresetService.List
      

   2. Check the server response to make sure your request was successful.

4. Change the host class as appropriate:

   1. Call the ClusterService/Update method, e.g., via the following gRPCurl request:

      Warning

      The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

      Format for listing settings

      "update_mask": {
          "paths": [
              "<setting_1>",
              "<setting_2>",
              ...
              "<setting_N>"
          ]
      }
      

      grpcurl \
          -format json \
          -import-path ~/cloudapi/ \
          -import-path ~/cloudapi/third_party/googleapis/ \
          -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
          -rpc-header "Authorization: Bearer $IAM_TOKEN" \
          -d '{
                "cluster_id": "<cluster_ID>",
                "update_mask": {
                  "paths": [
                    "config_spec.kraft.resources.resource_preset_id"
                  ]
                },
                "config_spec": {
                  "kraft": {
                    "resources": {
                      "resource_preset_id": "<KRaft_host_class_ID>"
                    }
                  }
                }
              }' \
          mdb.api.cloud.yandex.net:443 \
          yandex.cloud.mdb.kafka.v1.ClusterService.Update
      

      Where:

      • update_mask: List of settings you want to update as an array of strings (paths[]).

        Specify the relevant parameters:

        • config_spec.kraft.resources.resource_preset_id: To change the KRaft host class.

      You can get the cluster ID with the list of clusters in the folder. Earlier, you already obtained the list of available host classes with their IDs.

   2. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To edit the list of security groups for your cluster:

1. See the description of the CLI command for updating a cluster:

   yc managed-kafka cluster update --help
   

2. Run this command, specifying the security groups and public access settings:

   yc managed-kafka cluster update <cluster_name_or_ID> \
      --security-group-ids <list_of_security_groups> \
      --assign-public-ip=<enable_public_access_to_cluster>
   

   Where:

   • --security-group-ids: List of cluster security group IDs.
   • --assign-public-ip: Public access to the cluster, true or false.

   To find out the cluster name or ID, get the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. Change the values of the security_group_ids and assign_public_ip parameters in the cluster description:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     security_group_ids = [ <list_of_security_groups> ]
     ...
     config {
       assign_public_ip = "<enable_public_access_to_cluster>"
       ...
       }
   }
   

   Where:

   • security_group_ids: List of cluster security group IDs.
   • assign_public_ip: Public access to the cluster, true or false.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       -url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "securityGroupIds,configSpec.assignPublicIp",
                 "securityGroupIds": [
                   <list_of_security_group_IDs>
                 ],
                 "configSpec": {
                   "assignPublicIp": "<enable_public_access_to_cluster>"
                 }
               }'
   

   Where:

   • updateMask: Comma-separated string of settings you want to update.

     Specify the relevant parameters:

     • securityGroupIds: To change the list of security groups.
     • configSpec.assignPublicIp: To change the public access setting.

   • securityGroupIds: Security group IDs as an array of strings. Each string is a security group ID.

     Warning

     The list of security groups assigned to the cluster will be completely overwritten by the list provided in the securityGroupIds parameter.

     Before running your request, make sure the list includes all the required security group IDs, including existing ones.

   • assignPublicIp: Access to broker hosts from the internet, true or false.

   You can get the cluster ID with the list of clusters in the folder.

3. View the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService/Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "security_group_ids",
                 "config_spec.assign_public_ip"
               ]
             },
             "security_group_ids": [
               <list_of_security_group_IDs>
             ],
             "config_spec": {
               "assign_public_ip": "<enable_public_access_to_cluster>"
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Specify the relevant parameters:

     • security_group_ids: To change the list of security groups.
     • config_spec.assign_public_ip: To change the public access setting.

   • security_group_ids: Security group IDs as an array of strings. Each string is a security group ID.

     Warning

     The list of security groups assigned to the cluster will be completely overwritten by the list provided in the security_group_ids parameter.

     Before running your request, make sure the list includes all the required security group IDs, including existing ones.

   • assign_public_ip: Access to broker hosts from the internet, true or false.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To change additional cluster settings:

1. See the description of the CLI command for updating a cluster:

   yc managed-kafka cluster update --help
   

2. Run the following command with the list of settings you want to update:

   yc managed-kafka cluster update <cluster_name_or_ID> \
      --maintenance-window type=<maintenance_type>,`
                          `day=<day_of_week>,`
                          `hour=<hour> \
      --datatransfer-access=<allow_access_from_Data_Transfer> \
      --deletion-protection \
      --schema-registry=<data_schema_management>
   

You can update the following settings:

• --maintenance-window: Maintenance window settings (including for stopped clusters), where type is the maintenance type:

  • anytime: At any time (default).
  • weekly: On a schedule. For this value, also specify the following:
    • day: Day of week, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour of day (UTC), from 1 to 24.

• --deletion-protection: Cluster protection from accidental deletion, true or false.

  Even with cluster deletion protection enabled, one can still delete a user or topic or connect manually and delete the data.

• --schema-registry: Manage data schemas using Managed Schema Registry, true or false.

  Warning

  You cannot disable data schema management using Managed Schema Registry after connecting it.

To find out the cluster name or ID, get the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. To set up the maintenance window (for disabled clusters as well), add the maintenance_window section to the cluster description:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     maintenance_window {
       type = <maintenance_type>
       day  = <day_of_week>
       hour = <hour>
     }
     ...
   }
   

   Where:

   • type: Maintenance type. The possible values include:
     • ANYTIME: Anytime
     • WEEKLY: On a schedule
   • day: Day of week for the WEEKLY type, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
   • hour: UTC hour for the WEEKLY type, from 1 to 24.

3. To activate cluster protection against accidental deletion by a user of your cloud, add the deletion_protection field set to true to the cluster description:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     deletion_protection = <protect_cluster_against_deletion>
   }
   

   Even with cluster deletion protection enabled, one can still delete a user or topic or connect manually and delete the data.

4. To enable data schema management using Managed Schema Registry, add the config.schema_registry field set to true to the cluster description:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     config {
       ...
       schema_registry  = <data_schema_management>
     }
   }
   

   Warning

   You cannot disable data schema management using Managed Schema Registry after connecting it.

5. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

6. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       -url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.restApiConfig.enabled,configSpec.schemaRegistry,maintenanceWindow,deletionProtection",
                 "configSpec": {
                   "schemaRegistry": true,
                   "restApiConfig": {
                     "enabled": true
                   }
                 },
                 "maintenanceWindow": {
                   "anytime": {},
                   "weeklyMaintenanceWindow": {
                     "day": "<day_of_week>",
                     "hour": "<hour_UTC>"
                   }
                 },
                 "deletionProtection": <protect_cluster_against_deletion>
               }'
   

   Where:

   • updateMask: Comma-separated string of settings you want to update.

     Specify the relevant parameters:

     • configSpec.schemaRegistry: To enable the settings for data schema management using Managed Schema Registry.

     • configSpec.restApiConfig.enabled: To enable sending Apache Kafka® REST API requests.

     • maintenanceWindow: To change the maintenance window settings, including for stopped clusters.

     • deletionProtection: To enable or disable cluster protection from accidental deletion.

       Even with cluster deletion protection enabled, one can still delete a user or topic or connect manually and delete the data.

   • configSpec.schemaRegistry: Set to true to manage data schemas using Managed Schema Registry. You will not be able to edit this setting once it is enabled.

   • configSpec.restApiConfig.enabled: Set to true to enable sending Apache Kafka® REST API requests. You will not be able to edit this setting once it is enabled.

   • maintenanceWindow: Maintenance window settings, including for stopped clusters. Select one of these options:

     • anytime: At any time (default).
     • weeklyMaintenanceWindow: On schedule:
       • day: Day of week in DDD format, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Time of day (UTC) in HH format, from 1 to 24.

   • deletionProtection: To enable (true) or disable (false) cluster protection from accidental deletion.

     Even with cluster deletion protection enabled, one can still delete a user or topic or connect manually and delete the data.

   You can get the cluster ID with the list of clusters in the folder.

3. View the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService/Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "maintenance_window",
                 "deletion_protection",
                 "config_spec.schema_registry",
                 "config_spec.rest_api_config.enabled"
               ]
             },
             "config_spec": {
               "schema_registry": true,
               "rest_api_config": {
                 "enabled": true
               }
             },
             "maintenance_window": {
               "anytime": {},
               "weekly_maintenance_window": {
                 "day": "<day_of_week>",
                 "hour": "<hour_UTC>"
               }
             },
             "deletion_protection": <protect_cluster_against_deletion>
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Specify the relevant parameters:

     • config_spec.schema_registry: To manage data schemas using Managed Schema Registry.

     • config_spec.rest_api_config.enabled: To enable sending Apache Kafka® REST API requests.

     • maintenance_window: To change the maintenance window settings, including for stopped clusters.

     • deletion_protection: To enable or disable protection of the cluster, its databases, and users from accidental deletion.

   • schema_registry: Set to true to manage data schemas using Managed Schema Registry. You will not be able to edit this setting once it is enabled.

   • rest_api_config.enabled: Set to true to enable sending Apache Kafka® REST API requests. You will not be able to edit this setting once it is enabled.

   • maintenance_window: Maintenance window settings. Select one of these options:

     • anytime: Any time.
     • weekly_maintenance_window: On schedule:
       • day: Day of week in DDD format, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
       • hour: Time of day (UTC) in HH format, from 1 to 24.

   • deletion_protection: To enable (true) or disable (false) cluster protection from accidental deletion.

     Even with cluster deletion protection enabled, one can still delete a user or topic or connect manually and delete the data.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

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

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To update the Apache Kafka® settings:

1. See the description of the CLI command for updating cluster settings:

   yc managed-kafka cluster update --help
   

2. Run the cluster update command, providing the Apache Kafka® settings you want to change (the example below does not list all possible parameters):

   yc managed-kafka cluster update <cluster_name_or_ID> \
      --compression-type <compression_type> \
      --log-flush-interval-messages <number_of_messages_in_log> \
      --log-flush-interval-ms <maximum_time_to_store_messages>
   

   Where:

   • --log-flush-interval-messages: Number of messages in the log to trigger flushing to disk.
   • --log-flush-interval-ms: Maximum time a message can be stored in memory before flushing to disk.

   To find out the cluster name or ID, get the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for Apache Kafka® cluster description, edit the values of the parameters in the kafka.kafka_config section (the example below does not list all possible settings):

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     config {
       kafka {
         ...
         kafka_config {
           compression_type            = "<compression_type>"
           log_flush_interval_messages = <maximum_number_of_messages_in_memory>
           ...
         }
       }
     }
   }
   

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.update method, e.g., via the following cURL request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       -url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.kafka.kafkaConfig_2_8.<setting_1_for_Apache Kafka®_2.8_configuration>,...,configSpec.kafka.kafkaConfig_2_8.<setting_N_for_Apache Kafka®_2.8_configuration>,configSpec.kafka.kafkaConfig_3.<setting_1_for_Apache Kafka®_3.x_configuration>,...,configSpec.kafka.kafkaConfig_3.<setting_N_for_Apache Kafka®_3.x_configuration>",
                 "configSpec": {
                   "kafka": {
                     "kafkaConfig_2_8": {
                       "<setting_1_for_Apache Kafka®_2.8_configuration>": "<setting_value>",
                       "<setting_2_for_Apache Kafka®_2.8_configuration>": "<setting_value>",
                       ...,
                       "<setting_N_for_Apache Kafka®_2.8_configuration>": "<setting_value>"
                     },
                     "kafkaConfig_3": {
                       "<setting_1_for_Apache Kafka®_3.x_configuration>": "<setting_value>",
                       "<setting_2_for_Apache Kafka®_3.x_configuration>": "<setting_value>",
                       ...,
                       "<setting_N_for_Apache Kafka®_3.x_configuration>": "<setting_value>"
                     }
                   }
                 }
               }'
   

   Where:

   • updateMask: Comma-separated string of settings you want to update.

     Specify the relevant parameters:

     • configSpec.kafka.kafkaConfig_2_8.<setting_for_Apache Kafka®_2.8_configuration>: For Apache Kafka® 2.8.
     • configSpec.kafka.kafkaConfig_3.<setting_for_Apache Kafka®_3.x_configuration>: For Apache Kafka® 3.x.

   • configSpec.kafka.kafkaConfig_2_8.<setting_for_Apache Kafka®_2.8_configuration: Specify a new value for the setting if using Apache Kafka® 2.8.

   • configSpec.kafka.kafkaConfig_3.<setting_for_Apache Kafka®_3.x_configuration: Specify a new value for the setting if using Apache Kafka® 3.x.

   You can get the cluster ID with the list of clusters in the folder.

3. View the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService/Update method, e.g., via the following gRPCurl request:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.kafka.kafka_config_2_8.<setting_1_for_Apache Kafka®_2.8_configuration>",
                 ...,
                 "config_spec.kafka.kafka_config_2_8.<setting_N_for_Apache Kafka®_2.8_configuration>",
                 "config_spec.kafka.kafka_config_3.<setting_1_for_Apache Kafka®_3.x_configuration>",
                 ...,
                 "config_spec.kafka.kafka_config_3.<setting_N_for_Apache Kafka®_3.x_configuration>"
               ]
             }
             "config_spec": {
               "kafka": {
                 "kafka_config_2_8": {
                   "<setting_1_for_Apache Kafka®_2.8_configuration>": "<setting_value>",
                   "<setting_2_for_Apache Kafka®_2.8_configuration>": "<setting_value>",
                   ...,
                   "<setting_N_for_Apache Kafka®_2.8_configuration>": "<setting_value>"
                 },
                 "kafka_config_3": {
                   "<setting_1_for_Apache Kafka®_3.x_configuration>": "<setting_value>",
                   "<setting_2_for_Apache Kafka®_3.x_configuration>": "<setting_value>",
                   ...,
                   "<setting_N_for_Apache Kafka®_3.x_configuration>": "<setting_value>"
                 }
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of strings (paths[]).

     Specify the relevant parameters:

     • config_spec.kafka.kafka_config_2_8.<setting_for_Apache Kafka®_2.8_configuration>: For Apache Kafka® 2.8.
     • config_spec.kafka.kafka_config_3.<setting_for_Apache Kafka®_3.x_configuration>: For Apache Kafka® 3.x.

   • config_spec.kafka.kafka_config_2_8.<setting_for_Apache Kafka®_2.8_configuration: Specify a new value for the setting if using Apache Kafka® 2.8.

   • config_spec.kafka.kafka_config_3.<setting_for_Apache Kafka®_3.x_configuration: Specify a new value for the setting if using Apache Kafka® 3.x.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

1. Open the current Terraform configuration file describing your infrastructure.

   Learn how to create this file in Creating a cluster.

2. In the Managed Service for Apache Kafka® cluster description, edit or add the folder_id parameter value:

   resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
     ...
     folder_id = "<destination_folder_ID>"
   }
   

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

For more information, see this Terraform provider guide.

resource "yandex_mdb_kafka_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.move method, e.g., via the following cURL request:

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       -url 'https://mdb.api.cloud.yandex.net/managed-kafka/v1/clusters/<cluster_ID>:move' \
       --data '{
                 "destinationFolderId": "<folder_ID>"
               }'
   

   You can get the cluster ID with the list of clusters in the folder.

3. View the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it into an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService/Move method, e.g., via the following gRPCurl request:

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/kafka/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "destination_folder_id": "<folder_ID>"
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.kafka.v1.ClusterService.Move
   

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.