Updating a secret

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

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

1. View a description of the CLI command for adding resources to a secret:

   yc lockbox secret update --help
   

2. Run the command, specifying the secret name or ID:

   yc lockbox secret update \
     --id <secret_ID> \
     --new-name <new_secret_name> \
     --description <new_secret_description>
   

   Result:

   id: e6q2ig0u9b97********
   folder_id: b1gyggt2th59********
   created_at: "2021-11-08T19:23:00.383Z"
   name: <new_secret_name>
   description: <new_secret_description>
   status: ACTIVE
   current_version:
     id: e6q8ma3b6pd1********
     secret_id: e6q2ug0o9b24********
     created_at: "2021-11-08T19:23:00.383Z"
     status: ACTIVE
     payload_entry_keys:
     - <key>
   

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.

1. Open the Terraform configuration file and edit the fragment with the secret description:

   Sample secret description in the Terraform

   ...
   resource "yandex_lockbox_secret" "my_secret" {
     name                = "My secret"
     description         = "test secret from tf"
     folder_id           = "b1gmitvfx321d3********"
     kms_key_id          = "abjp8q2fjfg0s********"
     deletion_protection = true
     labels              = {
       tf-label    = "tf-label-value",
       empty-label = ""
     }
   }
   ...
   

2. Apply the changes:

   1. In the terminal, navigate to the configuration file directory.

   2. Make sure the configuration is correct using this command:

      terraform validate
      

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

      Success! The configuration is valid.
      

   3. Run this command:

      terraform plan
      

      You will see a list of resources and their properties. No changes will be made at this step. Terraform will show any errors in the configuration.

   4. Apply the configuration changes:

      terraform apply
      

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

You can check the secret's update and configuration using the management console or this CLI command:

yc lockbox secret get <secret_name>

To update a secret, use the update REST API method for the Secret resource or the SecretService/Update gRPC API call.