Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Creating a function version

Written by
Improved by
Updated at November 14, 2024

To create a function version, you can use one of the code upload formats. A ZIP archive will be used for the example.

Warning

Files larger than 3.5 MB should be uploaded via Object Storage. For more information about limits, see Quotas and limits in Cloud Functions.

Preparing a ZIP archive with the function code

  1. Save the following code to a file named index.js:

    exports.handler = async function (event, context) {
    let name = 'World';
    if (event.queryStringParameters && event.queryStringParameters.name) {
        name = event.queryStringParameters.name
    }
    return {
        'statusCode': 200,
        'headers': {
            'Content-Type': 'text/plain'
        },
        'isBase64Encoded': false,
        'body': `Hello, ${name}!`
    }
};

  2. Add the index.js file into the hello-js.zip ZIP archive.

Creating a function version

When creating a version, set the following parameters:

  • Runtime environment: Provides additional libraries and environment variables that can be accessed from the function code. It corresponds to the programming language your function is written in. For more information, see Runtime environment.
  • Entry point: Function to be invoked as a handler.
  • Timeout, sec: Maximum function execution time, after which the service will terminate its execution without waiting for a response. It includes the time of the first initialization when the function is first run.
  1. In the management console, select the folder containing the function.
  2. Select Cloud Functions.
  3. Select the function to create a version of.
  4. Under Last version, click Сreate in editor.
  5. Select the runtime environment. Disable the Add files with code examples option.
  6. Click Continue.
  7. Prepare the function code:
    • Runtime environment: nodejs18.
    • Method: ZIP archive.
    • File: hello-js.zip.
    • Entry point: index.handler.
  8. Set the version parameters:
  9. Click Save changes.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To create a function version, run the command:

yc serverless function version create \
  --function-name=my-nodejs-function \
  --runtime nodejs18 \
  --entrypoint index.handler \
  --memory 128m \
  --execution-timeout 5s \
  --source-path ./hello-js.zip

Where:

  • --function-name: Name of the function whose version you want to create.
  • --runtime: Runtime environment.
  • --entrypoint: Entry point in the following format: <file_name_without_extension>.<listener_name>.
  • --memory: Amount of RAM.
  • --execution-timeout: Maximum function running time before the timeout is reached.
  • --source-path: ZIP archive with the function code and required dependencies.

Result:

done (1s)
id: d4evvn8obisa********
function_id: d4elpv8pft63********
created_at: "2020-08-01T19:09:19.531Z"
runtime: nodejs18
entrypoint: index.handler
resources:
  memory: "134217728"
execution_timeout: 5s
image_size: "4096"
status: ACTIVE
tags:
  - $latest
log_options:
  folder_id: b1g681qpemb4********

Terraform allows you to quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. Configuration files store the infrastructure description in the HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Business Source License.

For more information about the provider resources, see the documentation on the Terraform website or the mirror.

If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

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

To create a new function version:

  1. Open the Terraform configuration file and change the function parameters:

    • yandex_function: Description of the function being created and its source code.
      • name: Function name.
      • description: Text description of the function.
      • user_hash: Any string to identify the function version. When the function changes, update this string, too. The function will update when this string is updated.
      • runtime: Function runtime environment.
      • entrypoint: Function name in the source code that will serve as an entry point to applications.
      • memory: Amount of memory allocated for the function, in MB.
      • execution_timeout: Function execution timeout.
      • service_account_id: ID of the service account under which the function will be called.
      • content: Function source code.
        • content.0.zip_filename: Name of the ZIP archive containing the function source code.

    Here is an example of the configuration file structure:

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

    Note

    If the function name or description is changed, the version will not be created.

    For more information about the yandex_function resource parameters, 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 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 new version using the management console or this CLI command:

yc serverless function version list --function-name <function_name>

To create a function version, use the createVersion REST API method for the Function resource or the FunctionService/CreateVersion gRPC API call.

Request example

To use the examples, install cURL and authenticate in the API.

  1. Upload the hello-js.zip archive with the function version code to your Object Storage bucket.

  2. Prepare a file named body.json with the following request body:

    {
  "functionId": "<function_ID>",
  "runtime": "nodejs18",
  "entrypoint": "index.handler",
  "resources": {
    "memory": "134217728"
  },
  "executionTimeout": "5s",
  "serviceAccountId": "<service_account_ID>",
  "package": {
    "bucketName": "<bucket_name>",
    "objectName": "hello-js.zip"
  },
}

    Where:

    • functionId: ID of the function the version of which you want to create.
    • runtime: Runtime environment.
    • entrypoint: Entry point in the following format: <file_name_without_extension>.<listener_name>.
    • memory: Amount of RAM.
    • executionTimeout: Maximum function running time before the timeout is reached.
    • serviceAccountId: ID of the service account with a role that allows bucket data reads.
    • bucketName: Name of the bucket where you uploaded the ZIP archive with the function code and required dependencies.
    • objectName: Key of the bucket object that contains the function code.

  3. Run this request:

    export IAM_TOKEN=<IAM_token>
curl \
    --request POST \
    --header "Authorization: Bearer ${IAM_TOKEN}" \
    --data "@<body.json_file_path>" \
    https://serverless-functions.api.cloud.yandex.net/functions/v1/versions

    Result:

    {
 "done": false,
 "metadata": {
  "@type": "type.googleapis.com/yandex.cloud.serverless.functions.v1.CreateFunctionVersionMetadata",
  "functionVersionId": "d4e25m0gila4********"
 },
 "id": "d4edk0oobcc9********",
 "description": "Create function version",
 "createdAt": "2023-10-11T11:22:21.286786431Z",
 "createdBy": "ajeol2afu1js********",
 "modifiedAt": "2023-10-11T11:22:21.286786431Z"
}

You can create a function version using the Yandex Cloud Toolkit plugin for the IDE family on the JetBrains IntelliJ platform.

Note

To ensure the integrity of version links, you cannot update or delete function versions. For more information about the resource relationships, see Function.

Previous
Creating a function
Next
Invoking a function