Updating a function description

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.

To update a function description, run this command:

yc serverless function update <function_name> --description "<function_description>"

Result:

id: b097d9ous3ge********
folder_id: aoek49ghmknn********
created_at: "2019-06-06T11:36:48.688Z"
name: my-beta-function
description: My beta function.
labels:
  test: test
log_group_id: eolv6578frac********
http_invoke_url: https://functions.yandexcloud.net/b097d9ous3ge********
status: ACTIVE

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

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

To update a function description:

1. Open the Terraform configuration file and edit the description field in the function description.

   Example of a function description in the Terraform configuration:

   resource "yandex_function" "test-function" {
       name               = "test-function"
       description        = "Test function"
       user_hash          = "first-function"
       runtime            = "python37"
       entrypoint         = "main"
       memory             = "128"
       execution_timeout  = "10"
       service_account_id = "<service_account_ID>"
       tags               = ["my_tag"]
       content {
           zip_filename = "<path_to_ZIP_archive>"
       }
   }
   

   For more information about yandex_function resource properties, see this provider guide.

2. Validate your configuration 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 function description update using the management console or this CLI command:

yc serverless function get <function_name_or_ID>

To update a function description, use the update REST API method for the Function resource or the FunctionService/Update gRPC API call.