Invoking a function asynchronously

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 set up asynchronous invocation, run the following command:

yc serverless function version create \
  --function-name=<function_name> \
  --runtime <runtime_environment> \
  --entrypoint <entry_point> \
  --memory <RAM_size> \
  --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 environment.
• --entrypoint: Entry point in <function_file_name>.<handler_name> format.
• --memory: Amount of RAM.
• --execution-timeout: Maximum function running time before the timeout is reached.
• --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 parameter, 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 parameter, 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.

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 set up 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_environment>"
     entrypoint         = "<entry_point>"
     memory             = "<RAM_size>"
     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 parameters:
     • retries_count: Number of retries before the invocation fails.
     • service_account_id: Service account with permissions to invoke the function.
     • ymq_failure_target: Parameters 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 parameter, no messages will be sent.
     • ymq_success_target: Parameters 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 parameter, no messages will be sent.

   For more information about the yandex_function resource properties, see the provider documentation.

2. Apply the changes:

   1. In the terminal, change to the folder where you edited the configuration file.

   2. Make sure the configuration file is correct using the command:

      terraform validate
      

      If the configuration is correct, the following message is returned:

      Success! The configuration is valid.
      

   3. Run the command:

      terraform plan
      

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

   4. Apply the configuration changes:

      terraform apply
      

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

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 set up asynchronous invocation, use the createVersion REST API method for the Function resource or the FunctionService/CreateVersion gRPC API call.