Creating a function version
To create a function version, you can use one of the code upload formats. This example uses a ZIP archive.
Warning
Use Object Storage to upload files larger than 3.5 MB. For more information about limits, see Quotas and limits in Cloud Functions.
Preparing a ZIP archive with the function code
-
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}!` } }; -
Add
index.jsto thehello-js.ziparchive.Note
If you use the Finder context menu to create a ZIP archive on macOS, the system automatically adds the
__MACOSXsystem directory to the archive. This directory may cause errors when you build functions. To delete this directory from your ZIP archive, use the command line to navigate to the folder containing the archive and run this command:zip -d <archive_name>.zip "__MACOSX/*"
Creating a function version
When creating a version, specify the following settings:
- Runtime environment: Provides additional libraries and environment variables accessible from the function code. It matches the programming language of your function. For more information, see Runtime.
- Entry point: Function to invoke as the handler.
- Timeout: Maximum function execution time. After this time, the service stops the function without waiting for a response. It includes the initialization time during the first run.
- In the management console
, navigate to the folder containing the function. - Go to Cloud Functions.
- Select the function whose version you want to create.
- Under Last version, click Сreate in editor.
- Select the runtime. Disable Add files with code examples.
- Click Continue.
- Prepare the function code:
- Runtime environment:
nodejs18. - Code source:
ZIP archive. - File:
hello-js.zip. - Entry point:
index.handler.
- Runtime environment:
- Configure the version:
- Timeout:
5. - Memory:
128 MB. - Service account:
Not selected. - Environment variables:
Not selected.
- Timeout:
- Click Save changes.
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 create a function version, run this 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.entrypoint: Entry point in<file_name_without_extension>.<handler_name>format.--memory: Amount of RAM.--execution-timeout: Maximum function execution time before timeout.--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********
With Terraform
Terraform is distributed under the Business Source License
For more information about the provider resources, see the relevant documentation on the Terraform
If you do not have Terraform yet, install it and configure the Yandex Cloud provider.
To create a new function version:
-
Open the Terraform configuration file and change the function settings:
yandex_function: Description of the new function and its source code.name: Function name.description: Text description of the function.user_hash: Any string to identify the function version. When you change the function, update this string as well. Updating this string triggers a function update.runtime: Function runtime.entrypoint: Function name in the source code that will serve as an entry point to applications.memory: Amount of memory allocated to the function, in MB.execution_timeout: Function execution timeout.service_account_id: ID of the service account you want to use to invoke the function.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 you change the function name or description, the system will not create a new version.
For more information about
yandex_functionresource properties, see this provider guide. -
Validate your configuration using this command:
terraform validateIf the configuration is valid, you will get this message:
Success! The configuration is valid. -
Run this command:
terraform planYou 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.
-
Apply the configuration changes:
terraform apply -
Type
yesand press Enter to confirm the changes.
You can check the new version using the management console
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 examples
To use the examples below, install cURL
Example where code is fetched from an Object Storage bucket
-
Upload the
hello-js.ziparchive with the function version code to your Object Storage bucket. -
Create a file named
body.jsonwith the following request body:{ "functionId": "<function_ID>", "runtime": "nodejs22", "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 whose version you want to create.runtime: Runtime.entrypoint: Entry point in<file_name_without_extension>.<handler_name>format.memory: Amount of RAM.executionTimeout: Maximum function execution time before timeout.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.
Example where code is provided in the request body
-
Encode the ZIP archive with the function code into Base64 format:
base64 -i hello-js.zip > output.txt -
Create a file named
body.jsonwith the following request body:{ "functionId": "<function_ID>", "runtime": "nodejs22", "entrypoint": "index.handler", "resources": { "memory": "134217728" }, "executionTimeout": "5s", "content": "<ZIP_archive_contents_in_Base64_encoding>" }Where:
functionId: ID of the function whose version you want to create.runtime: Runtime.entrypoint: Entry point in<file_name_without_extension>.<handler_name>format.memory: Amount of RAM.executionTimeout: Maximum function execution time before timeout.content: Function version code in Base64 encoding,output.txtfile contents.
Example where code is fetched from another function version in Cloud Functions
Create a file named body.json with the following request body:
{
"functionId": "<function_ID>",
"runtime": "nodejs22",
"entrypoint": "index.handler",
"resources": {
"memory": "134217728"
},
"executionTimeout": "5s",
"versionId": "<previous_function_version_ID>"
}
Where:
functionId: ID of the function whose version you want to create.runtime: Runtime.entrypoint: Entry point in<file_name_without_extension>.<handler_name>format.memory: Amount of RAM.executionTimeout: Maximum function execution time before timeout.versionId: ID of a previous function version.
Send the request by specifying the path to the previously created file with the request body:
export IAM_TOKEN=$(yc iam create-token)
curl -X POST \
-H "Authorization: Bearer ${IAM_TOKEN}" \
-d "@<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"
}
Note
To ensure integrity of relationships, you cannot update function versions. For more information about the resource relationships, see Function.