Invoking a function asynchronously

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 configure asynchronous invocation, run this command:

yc serverless function version create \
  --function-name=<function_name> \
  --runtime <runtime> \
  --entrypoint <entry_point> \
  --memory <RAM_amount> \
  --execution-timeout <execution_timeout> \
  --source-version-id <version_ID> \
  --async-max-retries <number_of_retry_attempts> \
  --async-service-account-id <service_account_ID> \
  --async-success-ymq-arn <message_queue> \
  --async-success-sa-id <service_account_ID> \
  --async-failure-ymq-arn <message_queue> \
  --async-failure-sa-id <service_account_ID>

Where:

• --function-name: Function name.
• --runtime: Runtime.
• --entrypoint: Entry point in <function_file_name>.<handler_name> format.
• --memory: Amount of RAM.
• --execution-timeout: Maximum function execution time before timeout.
• --source-version-id: ID of the function version from which you want to copy the code.
• --async-max-retries: Number of retries before the invocation fails.
• --async-service-account-id: ID of the service account with permissions to invoke the function.
• --async-success-ymq-arn: ARN of the destination queue in Message Queue for messages about successful function invocations. If you skip this setting, no messages will be sent.
• --async-success-sa-id: ID of the service account with permissions to write to the async-success-ymq-arn queue.
• --async-failure-ymq-arn: ARN of the destination queue in Message Queue for messages about failed function invocations. If you skip this setting, no messages will be sent.
• --async-failure-sa-id: ID of the service account with permissions to write to the async-failure-ymq-arn queue.

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 configure asynchronous invocation:

1. Open the Terraform configuration file and add the async_invocation section to the function description:

   resource "yandex_function" "test-function" {
     name               = "<function_name>"
     user_hash          = "<function_hash>"
     runtime            = "<runtime>"
     entrypoint         = "<entry_point>"
     memory             = "<RAM_amount>"
     execution_timeout  = "<execution_timeout>"
     service_account_id = "<service_account_ID>"
   
     async_invocation {
       retries_count       = "<number_of_retry_attempts>"
       service_account_id  = "<service_account_ID>"
       ymq_failure_target {
         service_account_id = "<service_account_ID>"
         arn                = "<message_queue>"
       }
       ymq_success_target {
         service_account_id = "service_account_ID"
         arn                = "<message_queue>"
       }
     }
   }
   

   Where:

   • async_invocation: Asynchronous invocation settings:
     • retries_count: Number of retries before the invocation fails.
     • service_account_id: Service account with permissions to invoke the function.
     • ymq_failure_target: Settings of the queue for failed invocations:
       • service_account_id: Service account with permissions to write to the queue for failed asynchronous invocations.
       • arn: ARN of the destination queue in Message Queue for messages about failed function invocations. If you skip this setting, no messages will be sent.
     • ymq_success_target: Settings of the queue for successful invocations:
       • service_account_id: Service account with permissions to write to the queue for successful asynchronous invocations.
       • arn: ARN of the destination queue in Message Queue for messages about successful function invocations. If you skip this setting, no messages will be sent.

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

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 function update and its settings using the management console or this CLI command:

yc serverless function version get <function_version_ID>

To configure asynchronous invocation, use the createVersion REST API method for the Function resource or the FunctionService/CreateVersion gRPC API call.