Creating a timer that invokes a Serverless Containers container
Create a timer — a trigger that invokes a Serverless Containers container on a schedule.
Getting started
To create a trigger, you will need:
-
A container that the trigger will invoke. If you do not have a container:
-
Optionally, a dead letter queue where messages that could not be processed by a container will be redirected. If you do not have a queue, create one.
-
Service account with rights to invoke the container and (optionally) write messages to the dead letter queue. You can use the same service account or different ones. If you do not have a service account, create one.
Creating a trigger
Note
The trigger is initiated within 5 minutes of being created.
-
In the management console
, select the folder where you want to create a trigger. -
Select Serverless Containers.
-
In the left-hand panel, select
Triggers. -
Click Create trigger.
-
Under Basic settings:
- Enter a name and description for the trigger.
- In the Type field, select
Timer
. - In the Launched resource field, select
Container
.
-
Under Timer settings:
- In the Cron expression field, specify the function invocation schedule as a cron expression.
- Optionally, in the Payload field, enter the message that will be sent to the function if the timer fires in the
payload
field. The data type is a string up to 4,096 characters long.
-
Under Container settings, select a container and specify a service account to invoke it under.
-
Optionally, under Repeat request settings:
- In the Interval field, specify the time interval to retry invoking the container if the current attempt fails. The values may range from 10 to 60 seconds. The default value is 10 seconds.
- In the Number of attempts field, specify the number of invocation retries before the trigger moves a message to the dead letter queue. The values may range from 1 to 5. The default value is 1.
-
Optionally, under Dead Letter Queue settings, select the dead-letter queue and the service account with write permissions for this queue.
-
Click Create trigger.
If you do not have the Yandex Cloud CLI installed yet, install and initialize it.
By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID>
command. You can also set a different folder for any specific command using the --folder-name
or --folder-id
parameter.
To create a trigger that invokes a container, run this command:
yc serverless trigger create timer \
--name <timer_name> \
--cron-expression '<cron_expression>' \
--payload <message> \
--invoke-container-id <container_ID> \
--invoke-container-service-account-id <service_account_ID> \
--retry-attempts <number_of_retry_attempts> \
--retry-interval <interval_between_retry_attempts> \
--dlq-queue-id <dead-letter_queue_ID> \
--dlq-service-account-id <service_account_ID>
Where:
--name
: Timer name.--cron-expression
: Container invocation schedule specified as a cron expression.--payload
: Message that will be sent to the function if the timer fires. The string length must not exceed 4,096 characters.
--invoke-container-id
: Container ID.--invoke-container-service-account-id
: ID of the service account with permissions to invoke the container.--retry-attempts
: Number of invocation retries before the trigger moves a message to the dead-letter queue. This is an optional parameter. The values may range from 1 to 5. The default value is 1.--retry-interval
: Time to retry invoking the container if the current attempt fails. This is an optional parameter. The values may range from 10 to 60 seconds. The default value is 10 seconds.--dlq-queue-id
: Dead-letter queue ID. This is an optional parameter.--dlq-service-account-id
: ID of the service account with write permissions to the dead-letter queue. This is an optional parameter.
Result:
id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2022-10-24T15:19:15.353909857Z"
name: timer
rule:
timer:
cron_expression: 5 10 ? * * *
payload: <message>
invoke_container_with_retry:
container_id: bba5jb38o8h2********
service_account_id: aje3932acdh2********
retry_settings:
retry_attempts: "1"
interval: 10s
dead_letter_queue:
queue-id: yrn:yc:ymq:ru-central1:b1gmit33ngh2********:dlq
service-account-id: aje3932acdh2********
status: ACTIVE
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 timer:
-
In the Terraform configuration file, describe the parameters of the resources you want to create:
resource "yandex_function_trigger" "my_trigger" { name = "<trigger_name>" container { id = "<container_ID>" service_account_id = "<service_account_ID>" retry_attempts = <number_of_retry_attempts> retry_interval = <interval_between_retry_attempts> } timer { cron_expression = "<cron_expression>" payload = "<message>" } dlq { queue_id = "<dead-letter_queue_ID>" service_account_id = "<service_account_ID>" } }
Where:
-
name
: Trigger name. The name format is as follows:- It must be from 2 to 63 characters long.
- It can only contain lowercase Latin letters, numbers, and hyphens.
- It must start with a letter and cannot end with a hyphen.
-
container
: Container parameters:id
: Container ID.service_account_id
: ID of the service account with rights to invoke the container.
retry_attempts
: Number of invocation retries before the trigger moves a message to the dead letter queue. This is an optional parameter. The values may range from 1 to 5. The default value is 1.retry_intervall
: Time to retry invoking the container if the current attempt fails. This is an optional parameter. The values may range from 10 to 60 seconds. The default value is 10 seconds.
-
timer
: Trigger parameters:cron_expression
: Container invocation schedule specified as a cron expression.payload
: Message that will be sent to the container if the timer fires. The string length must not exceed 4,096 characters.
dlq
: Dead-letter queue message parameters:queue_id
: Dead-letter queue ID. This is an optional parameter.service_account_id
: ID of the service account with write permissions to the dead-letter queue. This is an optional parameter.
For more information about the
function_trigger
resource properties, see the provider documentation . -
-
Create resources:
-
In the terminal, go to the directory where you edited the configuration file.
-
Make sure the configuration file is correct using this command:
terraform validate
If the configuration is correct, you will get this message:
Success! The configuration is valid.
-
Run this command:
terraform plan
You will see a detailed list of resources. No changes will be made at this step. If the configuration contains any errors, Terraform will show them.
-
Apply the changes:
terraform apply
-
Type
yes
and press Enter to confirm the changes.
Terraform will create all the required resources. You can check the new resources using the management console
or this CLI command:yc serverless trigger list
-
To create a timer, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.
Checking the result
Make sure the trigger is working properly. To do this, view container logs that show information about invocations.