Changing the name and description

Written by

Yandex Cloud

Updated at November 26, 2024

After creating a security group, you can change its name and description, and add or remove rules.

Management console

CLI

Terraform

API

To change the name or description of a group:

In the management console, go to the folder where you need to change the security group.
In the list of services, select Virtual Private Cloud.
In the left-hand panel, select Security groups.
Click next to the group you need to update.
In the menu that opens, click Edit.
Edit the group name and description and click Save.

To update the security group, run this command:

yc vpc security-group update <group_ID> --new-name test-sg-renamed

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

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.

Open the Terraform configuration file and edit the name and description parameters in the security group description:
```
...
resource "yandex_vpc_security_group" "test-sg" {
  name        = "Test security group"
  description = "Description for security group"
  network_id  = "${yandex_vpc_network.lab-net.id}"
}
...
```
For more information about the yandex_vpc_security_group resource parameters in Terraform, see the provider documentation.

Note

To manage the default security group, use the vpc_default_security_group resource.
Check the configuration using this command:
```
terraform validate
```
If the configuration is correct, you will get this message:
```
Success! The configuration is valid.
```
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.
Apply the configuration changes:
```
terraform apply
```
Confirm the changes: type yes into the terminal and press Enter.

You can check the security group update using the management console or this CLI command:
```
yc vpc security-group get <security_group_name>
```

To update the security group name or description, use the update REST API method for the SecurityGroup resource or the SecurityGroupService/Update gRPC API call, and provide the following in the request:

ID of the security group you want to update in the securityGroupId parameter.

To get the security group ID, use the list REST API method for the SecurityGroup resource or the SecurityGroupService/List gRPC API call and provide the folder ID in the folderId request parameter.

To learn how to find out the folder ID, see Getting the folder ID.
New name for the security group in the name parameter.
New description for the security group in the description parameter.
List of settings to update in the updateMask parameter.

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.

Changing the name and description

Was the article helpful?