Managing backup policies in Yandex Managed Service for Valkey™
Backup policies give you flexible control over how cluster backups are created and stored. You can configure a schedule for creating full backups and set their retention period.
Creating a backup policy
-
Navigate to Yandex Managed Service for Valkey™.
-
Click the name of your cluster and select the Backups tab.
-
On the Backup page, select the Backup policies tab.
-
Click Create policy.
-
Specify the parameters of the new policy:
-
Enter a name and description.
-
Select one of the backup start options:
- Every day.
- By day of the week. For this option, additionally select one or more days of the week.
- Monthly. For this option, additionally select one or more months and one or more days of the month.
The backup start time is specified in the cluster settings.
-
Configure backup storage. You can store backups for 7 to 1,095 days (up to three years).
-
-
Click Create.
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.
-
See the description of the CLI command for creating a policy:
yc managed-redis backup-retention-policy create --help -
Create a policy:
yc managed-redis backup-retention-policy create \ --cluster-id <cluster_ID> \ --policy-name <policy_name> \ --day-of-month <day_of_month> \ --month <month> \ --day-of-week <day_of_week> \ --retain-for-days <backup_retention_period_in_days> \ --description <policy_description>Where:
--cluster-id: Cluster ID. You can get it with the list of clusters.
--day-of-month: Day of the month. The possible value is1–31.--month: Month. The possible values are1–12orJAN–DEC.--day-of-week: Day of week. The possible values are0–6orSUN–SAT.--retain-for-days: Backup retention period in days. The possible value range is7–1095(up to three years).
The
--day-of-month,--month, and--day-of-weekdefine the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.Cron expressions also support the following special characters:
*: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.,: Listing multiple values.–: Specifying a range of values./: Specifying a step value. For example,*/3for the--day-of-monthsetting means a backup will be created every three days.
If no schedule settings are specified, backups are created using the cron expression
* * *, meaning they run daily.Examples of cron expressions:
1 */6 *: Backup is created on the first day of the month, every six months.31 jan SUN: Backup is created on Sundays in January, and also on January 31.* * WED: Backup is created every Wednesday.
You can test your cron expression in this editor
.Result:
policy_id: mdbt553glp51******** cluster_id: c9q5le6h1a4k******** policy_name: test-policy created_at: "2025-03-25T15:55:50.393000450Z" cron: day_of_month: "25" month: mar day_of_week: TUE retain_for_days: "300"
-
Open the current Terraform configuration file with the infrastructure plan.
For information on how to create this file, see Creating a cluster.
-
Add a resource description:
resource "yandex_mdb_redis_backup_retention_policy" "<policy_name>" { cluster_id = "<cluster_ID>" policy_name = "<policy_name>" description = "<policy_description>" retain_for_days = <backup_retention_period_in_days> cron = { day_of_month = "<day_of_month>" day_of_week = "<day_of_week>" month = "<month>" } }Where:
cluster_id: Cluster ID. You can get it with the list of clusters.
-
retain_for_days: Backup retention period in days. The possible value range is7–1095(up to three years). -
cron: Settings that define the schedule for creating backups.day_of_month: Day of the month. The possible value is1–31.day_of_week: Day of week. The possible values are0–6orSUN–SAT.month: Month. The possible values are1–12orJAN–DEC.
The schedule is defined as a cron expression without hours and minutes.
Cron expressions also support the following special characters:
*: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.,: Listing multiple values.–: Specifying a range of values./: Specifying a step value. For example,*/3for theday_of_monthsetting means a backup will be created every three days.
If no schedule settings are specified, backups are created using the cron expression
* * *, meaning they run daily.Examples of cron expressions:
1 */6 *: Backup is created on the first day of the month, every six months.31 jan SUN: Backup is created on Sundays in January, and also on January 31.* * WED: Backup is created every Wednesday.
You can test your cron expression in this editor
.
-
Make sure the configuration files are correct.
-
In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.
-
Run this command:
terraform validateTerraform will show any errors found in your configuration files.
-
-
Confirm updating the resources.
-
Run this command to view the planned changes:
terraform planIf you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
-
If everything looks correct, apply the changes:
-
Run this command:
terraform apply -
Confirm updating the resources.
-
Wait for the operation to complete.
-
For more information, see this Terraform provider guide.
-
-
Get an IAM token for API authentication and put it into an environment variable:
export IAM_TOKEN="<IAM_token>" -
Call the BackupRetentionPolicy.Create method, for instance, via the following cURL
request:curl \ --request POST \ --header "Authorization: Bearer $IAM_TOKEN" \ --header "Content-Type: application/json" \ --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<cluster_ID>/retention_policies' \ --data '{ "cron": { "dayOfMonth": "<day_of_month>", "month": "<month>", "dayOfWeek": "<day_of_week>" }, "retainForDays": "<retention_period_in_days>", "description": "<policy_description>", "policyName": "<policy_name>" }'Where:
<cluster_ID>: Cluster ID which you can get with the list of clusters.
dayOfMonth: Day of the month. The possible value is1-31.month: Month. The possible values are1-12orJAN-DEC.dayOfWeek: Day of week. The possible values are0-6orSUN-SAT.retainForDays: Backup retention period in days. The possible value range is7–1095(up to three years).
The
dayOfMonth,month, anddayOfWeekdefine the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.Cron expressions also support the following special characters:
*: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.,: Listing multiple values.–: Specifying a range of values./: Specifying a step value. For example,*/3for thedayOfMonthsetting means a backup will be created every three days.
If no schedule settings are specified, backups are created using the cron expression
* * *, meaning they run daily.Examples of cron expressions:
1 */6 *: Backup is created on the first day of the month, every six months.31 jan SUN: Backup is created on Sundays in January, and also on January 31.* * WED: Backup is created every Wednesday.
You can test your cron expression in this editor
. -
Check the server response to make sure your request was successful.
-
Get an IAM token for API authentication and put it into an environment variable:
export IAM_TOKEN="<IAM_token>" -
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiBelow, we assume that the repository contents reside in the
~/cloudapi/directory. -
To create a policy:
-
Call the BackupRetentionPolicyService.Create method, for instance, via the following gRPCurl
request:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_retention_policy_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>", "cron": { "day_of_month": "<day_of_month>", "month": "<month>", "day_of_week": "<day_of_week>" }, "retain_for_days": "<backup_retention_period_in_days>", "description": "<policy_description>", "policy_name": "<policy_name>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.redis.v1.BackupRetentionPolicyService.CreateWhere:
cluster_id: Cluster ID. You can get it with the list of clusters.
day_of_month: Day of the month. The possible value is1–31.month: Month. The possible values are1–12orJAN–DEC.day_of_week: Day of week. The possible values are0–6orSUN–SAT.retain_for_days: Backup retention period in days. The possible value range is7–1095(up to three years).
The
day_of_month,month, andday_of_weekdefine the schedule for creating backups. The schedule is defined as a cron expression without hours and minutes.Cron expressions also support the following special characters:
*: Selecting all possible values. A backup will be created on each scheduled interval (day or month) when possible, provided it does not conflict with other settings. This option is used by default if the setting is not specified.,: Listing multiple values.–: Specifying a range of values./: Specifying a step value. For example,*/3for theday_of_monthsetting means a backup will be created every three days.
If no schedule settings are specified, backups are created using the cron expression
* * *, meaning they run daily.Examples of cron expressions:
1 */6 *: Backup is created on the first day of the month, every six months.31 jan SUN: Backup is created on Sundays in January, and also on January 31.* * WED: Backup is created every Wednesday.
You can test your cron expression in this editor
. -
Check the server response to make sure your request was successful.
-
Getting a list of backup policies
- Navigate to Yandex Managed Service for Valkey™.
- Click the name of your cluster and select the Backups tab.
- On the Backup page, select the Backup policies tab.
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.
-
See the description of the CLI command for getting a list of policies:
yc managed-redis backup-retention-policy list --help -
Get a list of policies for the Yandex Managed Service for Valkey™ cluster:
yc managed-redis backup-retention-policy list \ --cluster-id <cluster_ID>You can get the cluster ID from the cluster list.
Result:
+----------------------+-------------+--------------------+------------+-------------------+ | ID | NAME | CLUSTER ID | CRONTAB | RETENTION PERIOD | +----------------------+-------------+--------------------+------------+-------------------+ | mdbt553glp51******** | test-policy | c9q5le6h1a4******* | 31 JAN SUN | 50 | +----------------------+-------------+--------------------+------------+-------------------+Order of parameters in the
CRONTABcolumn:--day-of-month,--month,--day-of-week.
-
Get an IAM token for API authentication and put it into an environment variable:
export IAM_TOKEN="<IAM_token>" -
Call the BackupRetentionPolicy.List method, for instance, via the following cURL
request:curl \ --request GET \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<cluster_ID>/retention_policies?pageSize=<number_of_results>'Where:
<cluster_ID>: Cluster ID which you can get with the list of clusters.pageSize: Number of query results per page. Specify a number greater than zero.
-
Check the server response to make sure your request was successful.
-
Get an IAM token for API authentication and put it into an environment variable:
export IAM_TOKEN="<IAM_token>" -
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiBelow, we assume that the repository contents reside in the
~/cloudapi/directory. -
To get a list of policies for a cluster:
-
Call the BackupRetentionPolicyService.List method, for instance, via the following gRPCurl
request:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_retention_policy_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "cluster_id": "<cluster_ID>", "page_size": "<number_of_results>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.redis.v1.BackupRetentionPolicyService.ListWhere:
cluster_id: Cluster ID. You can get it with the list of clusters.page_size: Number of query results per page. Specify a number greater than zero.
-
Check the server response to make sure your request was successful.
-
Deleting a backup policy
- Navigate to Yandex Managed Service for Valkey™.
- Click the name of your cluster and select the Backups tab.
- On the Backup page, select the Backup policies tab.
- Click
in the row of the policy you want to delete. - Select Delete.
- In the window that opens, click Delete.
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.
-
See the description of the CLI command for deleting a policy:
yc managed-redis backup-retention-policy delete --help -
Delete a policy:
yc managed-redis backup-retention-policy delete <policy_ID> \ --cluster-id <cluster_ID>You can get the cluster ID from the list of clusters, and the policy ID from the list of policies.
-
Open the current Terraform configuration file with the infrastructure plan.
For information on how to create this file, see Creating a cluster.
-
Delete the
yandex_mdb_redis_backup_retention_policyresource with the name of the policy you want to delete. -
Make sure the configuration files are correct.
-
In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.
-
Run this command:
terraform validateTerraform will show any errors found in your configuration files.
-
-
Confirm updating the resources.
-
Run this command to view the planned changes:
terraform planIf you described the configuration correctly, the terminal will display a list of the resources to update and their parameters. This is a verification step that does not apply changes to your resources.
-
If everything looks correct, apply the changes:
-
Run this command:
terraform apply -
Confirm updating the resources.
-
Wait for the operation to complete.
-
-
-
Get an IAM token for API authentication and put it into an environment variable:
export IAM_TOKEN="<IAM_token>" -
Call the BackupRetentionPolicy.Delete method, for instance, via the following cURL
request:curl \ --request DELETE \ --header "Authorization: Bearer $IAM_TOKEN" \ --url 'https://mdb.api.cloud.yandex.net/managed-redis/v1/clusters/<cluster_ID>/retention_policies/<policy_ID>'You can get the cluster ID from the list of clusters, and the policy ID from the list of policies.
-
Check the server response to make sure your request was successful.
-
Get an IAM token for API authentication and put it into an environment variable:
export IAM_TOKEN="<IAM_token>" -
Clone the cloudapi
repository:cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapiBelow, we assume that the repository contents reside in the
~/cloudapi/directory. -
To delete a policy:
-
Call the BackupRetentionPolicyService.Delete method, for instance, via the following gRPCurl
request:grpcurl \ -format json \ -import-path ~/cloudapi/ \ -import-path ~/cloudapi/third_party/googleapis/ \ -proto ~/cloudapi/yandex/cloud/mdb/redis/v1/backup_retention_policy_service.proto \ -rpc-header "Authorization: Bearer $IAM_TOKEN" \ -d '{ "policy_id": "<policy_ID>", "cluster_id": "<cluster_ID>" }' \ mdb.api.cloud.yandex.net:443 \ yandex.cloud.mdb.redis.v1.BackupRetentionPolicyService.DeleteYou can get the cluster ID from the list of clusters, and the policy ID from the list of policies.
-
Check the server response to make sure your request was successful.
-