Updating the description of a function

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

The folder specified when creating the CLI profile is used by default. To change the default folder, use the yc config set folder-id <folder_ID> command. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the function description, run the 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 documentation on the Terraform website or mirror website.

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

To update the function description:

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

   Example 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 the yandex_function resource properties, see the provider documentation.

2. Check the configuration using this command:

   terraform validate
   

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

   Success! The configuration is valid.
   

3. Run this command:

   terraform plan
   

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

4. Apply the configuration changes:

   terraform apply
   

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

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.

You can update the function description using the Yandex Cloud Toolkit plugin for the IDE family on the JetBrains IntelliJ platform.