Managing backups in Managed Service for PostgreSQL

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the cluster will be restored to the same folder where the backup is located. To restore the cluster to a different folder, specify its ID in the --folder-id option.

To restore a cluster from a backup:

1. View the description of the CLI command for restoring a PostgreSQL cluster:

   yc managed-postgresql cluster restore --help
   

2. Get the list of available PostgreSQL cluster backups:

   yc managed-postgresql backup list
   

   +--------------------------+---------------------+----------------------+---------------------+
   |              ID          |      CREATED AT     |  SOURCE CLUSTER ID   |      STARTED AT     |
   +--------------------------+---------------------+----------------------+---------------------+
   | c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 |
   | ...                                                                                         |
   +--------------------------+---------------------+----------------------+---------------------+
   

   The CREATED AT column in the list of available backups shows the backup completion time in yyyy-mm-dd hh:mm:ss format (2020-08-10 12:00:00 in the example above). You can restore your cluster to the state it was in at any point in time after the backup was created.

3. Make the following request to create a cluster from a backup:

   yc managed-postgresql cluster restore \
      --backup-id=<backup_ID> \
      --time=<time> \
      --name=<cluster_name> \
      --environment=<environment> \
      --network-name=<network_name> \
      --host zone-id=<availability_zone>,`
            `subnet-name=<subnet_name>,`
            `assign-public-ip=<allow_public_access_to_host> \
      --resource-preset=<host_class> \
      --disk-size=<storage_size_in_GB> \
      --disk-type=<disk_type>
   

   Where:

   • --backup-id: Backup ID.

   • --time: Point in time to restore the PostgreSQL cluster to, in yyyy-mm-ddThh:mm:ssZ format.

   • --name: Cluster name.

   • --environment: Environment:

     • PRESTABLE: For testing purposes. The prestable environment is similar to the production environment and is also covered by an SLA. However, it receives new features, improvements, and bug fixes earlier. In the prestable environment, you can test new versions for compatibility with your application.
     • PRODUCTION: For stable versions of your applications.

   • --network-name: Network name.

   • --host: Host settings:

     • zone-id: Availability zone.

     • subnet-name: Subnet name. You must specify this setting if the selected availability zone has more than one subnet.

     • assign-public-ip: Flag to add if public access to the host is required (true or false).

   • --resource-preset: Host class.

   • --disk-size: Storage size, in GB.

   • --disk-type: Disk type:

     • network-hdd
     • network-ssd
     • local-ssd
     • network-ssd-nonreplicated * network-ssd-io-m3

Use Terraform to restore:

• Existing cluster from a backup.
• Cluster created and then deleted via the management console, CLI, or API.

You will need the backup ID for the restoration. Get a list of available PostgreSQL cluster backups using the CLI:

yc managed-postgresql backup list

+--------------------------+---------------------+----------------------+---------------------+
|            ID            |      CREATED AT     |  SOURCE CLUSTER ID   |      STARTED AT     |
+--------------------------+---------------------+----------------------+---------------------+
| c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 |
| ...                                                                                         |
+--------------------------+---------------------+----------------------+---------------------+

resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
  ...
  timeouts {
    create = "1h30m" # 1 hour 30 minutes
    update = "2h"    # 2 hours
    delete = "30m"   # 30 minutes
  }
}

To restore an existing cluster from a backup:

1. Create a Terraform configuration file for the new cluster.

   Do not specify database (yandex_mdb_postgresql_database) and user (yandex_mdb_postgresql_user) resources as they will be restored from the backup.

2. Add the restore section to the configuration file:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     restore {
       backup_id = "<backup_ID>"
       time      = "<time>"
     }
   }
   

   Where:

   • backup_id: Backup ID.
   • time: Point in time to restore the PostgreSQL cluster to, starting from the selected backup's creation time. Format: yyyy-mm-ddThh:mm:ss.

   Note

   If you omit the time setting, the cluster will be restored to the backup’s completion time.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If 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.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

Terraform will create a copy of the existing cluster. The databases and users will be deployed from the selected backup.

To restore a previously deleted cluster from a backup:

1. Create a Terraform configuration file for the new cluster.

   Do not specify database (yandex_mdb_postgresql_database) and user (yandex_mdb_postgresql_user) resources as they will be restored from the backup.

2. In this configuration file, add the restore section with the name of the backup for restoration:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     restore {
         backup_id = "<backup_ID>"
     }
   }
   

   Where backup-id is the ID of the deleted cluster’s backup.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If 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.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

Terraform will create the new cluster. The databases and users will be deployed from the backup.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Create a file named body.json and paste the following code into it:

   {
     "backupId": "<backup_ID>",
     "time": "<time>",
     "folderId": "<folder_ID>",
     "name": "<cluster_name>",
     "environment": "<environment>",
     "networkId": "<network_ID>",
     "configSpec": {
       "version": "<PostgreSQL_version>",
       "resources": {
         "resourcePresetId": "<host_class>",
         "diskSize": "<storage_size_in_bytes>",
         "diskTypeId": "<disk_type>"
       }
     },
     "hostSpecs": [
       {
         "zoneId": "<availability_zone>",
         "subnetId": "<subnet_ID>",
         "assignPublicIp": <allow_public_access_to_host>
       }
     ]
   }
   

   Where:

   • backupId: Backup ID. You can get it from the backup list.

   • time: Point in time to restore the PostgreSQL cluster to, in yyyy-mm-ddThh:mm:ssZ format.

   • folderId: ID of the target folder to restore the cluster. You can get the folder ID with the list of folders in the cloud.

   • name: Cluster name.

   • environment: Environment:

     • PRESTABLE: For testing purposes. The prestable environment is similar to the production environment and is also covered by an SLA. However, it receives new features, improvements, and bug fixes earlier. In the prestable environment, you can test new versions for compatibility with your application.
     • PRODUCTION: For stable versions of your applications.

   • networkId: Network ID.

   • configSpec: Cluster settings:

     • version: PostgreSQL version.

     • resources: Cluster resources:

       • resourcePresetId: Host class.
       • diskSize: Disk size, in bytes.
       • diskTypeId: Disk type.

   • hostSpecs: Cluster host settings as an array of elements, one per host. Each element has the following structure:

     • zoneId: Availability zone.
     • subnetId: Subnet ID.
     • assignPublicIp: Permission to connect to the host from the internet, true or false.

3. Call the Cluster.Restore method, e.g., 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-postgresql/v1/clusters:restore' \
     --data "@body.json"
   

4. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Create a file named body.json and paste the following code into it:

   {
     "backup_id": "<backup_ID>",
     "time": "<time>",
     "folder_id": "<folder_ID>",
     "name": "<cluster_name>",
     "environment": "<environment>",
     "network_id": "<network_ID>",
     "config_spec": {
       "version": "<PostgreSQL_version>",
       "resources": {
         "resource_preset_id": "<host_class>",
         "disk_size": "<storage_size_in_bytes>",
         "disk_type_id": "<disk_type>"
       }
     },
     "host_specs": [
       {
         "zone_id": "<availability_zone>",
         "subnet_id": "<subnet_ID>",
         "assign_public_ip": <allow_public_access_to_host>
       }
     ]
   }
   

   Where:

   • backup_id: Backup ID. You can get it with the list of backups.

   • time: Point in time to restore the PostgreSQL cluster to, in yyyy-mm-ddThh:mm:ssZ format.

   • folder_id: ID of the target folder to restore the cluster. You can request the ID with the list of folders in the cloud.

   • name: Cluster name.

   • environment: Environment:

     • PRESTABLE: For testing purposes. The prestable environment is similar to the production environment and is also covered by an SLA. However, it receives new features, improvements, and bug fixes earlier. In the prestable environment, you can test new versions for compatibility with your application.
     • PRODUCTION: For stable versions of your applications.

   • network_id: Network ID.

   • config_spec: Cluster settings:

     • version: PostgreSQL version.

     • resources: Cluster resources:

       • resource_preset_id: Host class.
       • disk_size: Disk size, in bytes.
       • disk_type_id: Disk type.

   • host_specs: Cluster host settings as an array of elements, one per host. Each element has the following structure:

     • zone_id: Availability zone.
     • subnet_id: Subnet ID.
     • assign_public_ip: Permission to connect to the host from the internet, true or false.

4. Call the ClusterService.Restore method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d @ \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.ClusterService.Restore \
     < body.json
   

5. Check the server response to make sure your request was successful.

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 cluster backup:

1. View the description of the CLI command for creating a PostgreSQL backup:

   yc managed-postgresql cluster backup --help
   

2. Send a request to create a cluster backup by specifying the cluster name or ID:

   yc managed-postgresql cluster backup my-pg-cluster
   

   You can get the cluster name and ID from the list of clusters.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Cluster.Backup method, e.g., 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-postgresql/v1/clusters/<cluster_ID>:backup'
   

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the ClusterService.Backup 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/postgresql/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<cluster_ID>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.ClusterService.Backup
   

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

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 get a list of PostgreSQL cluster backups available in the default folder, run this command:

yc managed-postgresql backup list

+--------------------------+---------------------+----------------------+---------------------+
|            ID            |      CREATED AT     |  SOURCE CLUSTER ID   |      STARTED AT     |
+--------------------------+---------------------+----------------------+---------------------+
| c9qlk4v13uq7********:... | 2020-08-10 12:00:00 | c9qlk4v13uq7******** | 2020-08-10 11:55:17 |
| c9qpm90p3pcg********:... | 2020-08-09 22:01:04 | c9qpm90p3pcg******** | 2020-08-09 21:30:00 |
+--------------------------+---------------------+----------------------+---------------------+

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. To get a list of cluster backups:

   1. Call the Cluster.ListBackups method, e.g., via the following cURL request:

      curl \
         --request GET \
         --header "Authorization: Bearer $IAM_TOKEN" \
         --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>/backups'
      

      You can get the cluster ID with the list of clusters in the folder.

   2. Check the server response to make sure your request was successful.

3. To get a list of backups for all clusters in a folder:

   1. Call the Backup.List method, e.g., via the following cURL request:

      curl \
         --request GET \
         --header "Authorization: Bearer $IAM_TOKEN" \
         --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/backups' \
         --url-query folderId=<folder_ID>
      

      You can get the folder ID with the list of folders in the cloud.

   2. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. To get a list of cluster backups:

   1. Call the ClusterService.ListBackups method, e.g., via the following gRPCurl request:

      grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d '{
              "cluster_id": "<cluster_ID>"
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.postgresql.v1.ClusterService.ListBackups
      

      You can get the cluster ID with the list of clusters in the folder.

   2. Check the server response to make sure your request was successful.

4. To list backups for all clusters in your folder:

   1. Call the BackupService.List method, e.g., via the following gRPCurl request:

      grpcurl \
        -format json \
        -import-path ~/cloudapi/ \
        -import-path ~/cloudapi/third_party/googleapis/ \
        -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/backup_service.proto \
        -rpc-header "Authorization: Bearer $IAM_TOKEN" \
        -d '{
              "folder_id": "<folder_ID>"
            }' \
        mdb.api.cloud.yandex.net:443 \
        yandex.cloud.mdb.postgresql.v1.BackupService.List
      

      You can get the folder ID with the list of folders in the cloud.

   2. Check the server response to make sure your request was successful.

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 get backup details for a PostgreSQL cluster, run this command:

yc managed-postgresql backup get <backup_ID>

You can get the backup ID with the list of backups.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Backup.Get method, e.g., via the following cURL request:

   curl \
      --request GET \
      --header "Authorization: Bearer $IAM_TOKEN" \
      --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/backups/<backup_ID>'
   

   You can get the backup ID with the list of backups.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the BackupService.Get method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/backup_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "backup_id": "<backup_ID>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.BackupService.Get
   

   You can get the backup ID with the list of backups.

4. Check the server response to make sure your request was successful.

To set the backup start time, use the --backup-window-start option. You must specify the time in HH:MM:SS format.

yc managed-postgresql cluster create \
   --cluster-name <cluster_name> \
   --environment <environment> \
   --network-name <network_name> \
   --host zone-id=<availability_zone>,subnet-id=<subnet_ID> \
   --resource-preset <host_class> \
   --user name=<username>,password=<user_password> \
   --database name=<DB_name>,owner=<DB_owner_name> \
   --disk-size <storage_size_in_GB>
   --backup-window-start 10:00:00

Where environment is the environment, either prestable or production.

To change the backup start time for an existing cluster, use the update command:

yc managed-postgresql cluster update \
   --cluster-name <cluster_name> \
   --backup-window-start 11:25:00

1. Open the current Terraform configuration file describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

   For a complete list of Managed Service for PostgreSQL cluster configuration fields you can update, see this Terraform provider guide.

2. Add the backup_window_start block to the config section of the Managed Service for PostgreSQL cluster description:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     config {
       ...
       backup_window_start {
         hours   = <hour>
         minutes = <minute>
       }
       ...
     }
     ...
   

   Where:

   • hours: Backup start hour (UTC).
   • minutes: Backup start minute (UTC).

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If 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.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Timeouts

   The Terraform provider sets the following timeouts for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoration from a backup: 30 minutes.
   • Updating a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the timeout are aborted.

   How can I change these timeouts?

   Add a timeouts section to the cluster description, e.g.:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and send the following request, e.g., via cURL:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
     --request PATCH \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>' \
     --data '{
               "updateMask": "configSpec.backupWindowStart",
               "configSpec": {
                 "backupWindowStart": {
                   "hours": "<hours>",
                   "minutes": "<minutes>",
                   "seconds": "<seconds>",
                   "nanos": "<nanoseconds>"
                 }
               }
             }'
   

   Where:

   • updateMask: Comma-separated string of settings you want to update.

     Here, we provide only one setting.

   • configSpec.backupWindowStart: Backup window settings.

     In this setting, specify the backup start time. Allowed values:

     • hours: Between 0 and 23 hours.
     • minutes: Between 0 and 59 minutes.
     • seconds: Between 0 and 59 seconds.
     • nanos: Between 0 and 999999999 nanoseconds.

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Use the ClusterService.Update call and send the following request, e.g., via gRPCurl:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "cluster_id": "<cluster_ID>",
           "update_mask": {
             "paths": [
               "config_spec.backup_window_start"
             ]
           },
           "config_spec": {
             "backup_window_start": {
               "hours": "<hours>",
               "minutes": "<minutes>",
               "seconds": "<seconds>",
               "nanos": "<nanoseconds>"
             }
           }
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • config_spec.backup_window_start: Backup window settings.

     Here, specify the backup start time. Allowed values:

     • hours: Between 0 and 23 hours.
     • minutes: Between 0 and 59 minutes.
     • seconds: Between 0 and 59 seconds.
     • nanos: Between 0 and 999999999 nanoseconds.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

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 set the retention period for automatic backups, provide the required value for the --backup-retain-period-days argument of the cluster update command:

yc managed-postgresql cluster update <cluster_name_or_ID> \
   --backup-retain-period-days=<retention_period_in_days>

Allowed values range from 7 to 60. The default value is 7.

You can get the cluster ID and name with the list of clusters in the folder.

1. Open the current Terraform configuration file describing your infrastructure.

   To learn how to create this file, see Creating a cluster.

   For a complete list of Managed Service for PostgreSQL cluster configuration fields you can update, see this Terraform provider guide.

2. Add the backup_retain_period_days block to the config section of the Managed Service for PostgreSQL cluster description:

     resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
       ...
       config {
         ...
         backup_retain_period_days = <retention_period_in_days>
         }
         ...
       }
       ...
   

   Where backup_retain_period_days is the automatic backup retention period.

   Allowed values range from 7 to 60. The default value is 7.

3. Make sure the settings are correct.

   1. In the command line, navigate to the directory that contains the current Terraform configuration files defining the infrastructure.

   2. Run this command:

      terraform validate
      

      Terraform will show any errors found in your configuration files.

4. Confirm updating the resources.

   1. Run this command to view the planned changes:

      terraform plan
      

      If 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.

   2. If everything looks correct, apply the changes:

      1. Run this command:

         terraform apply
         

      2. Confirm updating the resources.

      3. Wait for the operation to complete.

   Timeouts

   The Terraform provider sets the following timeouts for Managed Service for PostgreSQL cluster operations:

   • Creating a cluster, including restoration from a backup: 30 minutes.
   • Updating a cluster: 60 minutes.
   • Deleting a cluster: 15 minutes.

   Operations exceeding the timeout are aborted.

   How can I change these timeouts?

   Add a timeouts section to the cluster description, e.g.:

   resource "yandex_mdb_postgresql_cluster" "<cluster_name>" {
     ...
     timeouts {
       create = "1h30m" # 1 hour 30 minutes
       update = "2h"    # 2 hours
       delete = "30m"   # 30 minutes
     }
   }
   

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.Update method and send the following request, e.g., via cURL:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the updateMask parameter as a single comma-separated string.

   curl \
     --request PATCH \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/clusters/<cluster_ID>' \
     --data '{
               "updateMask": "configSpec.backupRetainPeriodDays",
               "configSpec": {
                 "backupRetainPeriodDays": <retention_period_in_days>
               }
             }'
   

   Where:

   • updateMask: Comma-separated string of settings you want to update.

     Here, we provide only one setting.

   • configSpec.backupRetainPeriodDays: Automatic backup retention period.

     The valid values range from 7 to 60. The default value is 7.

   You can get the cluster ID with the list of clusters in the folder.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Use the ClusterService.Update call and send the following request, e.g., via gRPCurl:

   Warning

   The API method will assign default values to all the parameters of the object you are modifying unless you explicitly provide them in your request. To avoid this, list the settings you want to change in the update_mask parameter as an array of paths[] strings.

   Format for listing settings

   "update_mask": {
       "paths": [
           "<setting_1>",
           "<setting_2>",
           ...
           "<setting_N>"
       ]
   }
   

   grpcurl \
   -format json \
   -import-path ~/cloudapi/ \
   -import-path ~/cloudapi/third_party/googleapis/ \
   -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/cluster_service.proto \
   -rpc-header "Authorization: Bearer $IAM_TOKEN" \
   -d '{
           "cluster_id": "<cluster_ID>",
           "update_mask": {
           "paths": [
               "config_spec.backup_retain_period_days"
           ]
           },
           "config_spec": {
           "backup_retain_period_days": <retention_period_in_days>
           }
       }' \
   mdb.api.cloud.yandex.net:443 \
   yandex.cloud.mdb.postgresql.v1.ClusterService.Update
   

   Where:

   • update_mask: List of parameters to update as an array of strings (paths[]).

     Here, we provide only one setting.

   • config_spec.backup_retain_period_days: Automatic backup retention period.

     Allowed values range from 7 to 60. The default value is 7.

   You can get the cluster ID with the list of clusters in the folder.

4. Check the server response to make sure your request was successful.

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 delete a backup:

1. View the description of the CLI command for deleting a PostgreSQL cluster backup:

   yc managed-postgresql backup delete --help
   

2. Send a request to delete a backup by specifying the backup ID:

   yc managed-postgresql backup delete <backup_ID>
   

You can get the backup ID with the list of backups.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Call the Backup.Delete method, e.g., via the following cURL request:

   curl \
     --request DELETE \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --url 'https://mdb.api.cloud.yandex.net/managed-postgresql/v1/backups/<backup_ID>'
   

   You can get the backup ID with the list of backups.

3. Check the server response to make sure your request was successful.

1. Get an IAM token for API authentication and put it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Clone the cloudapi repository:

   cd ~/ && git clone --depth=1 https://github.com/yandex-cloud/cloudapi
   

   Below, we assume that the repository contents reside in the ~/cloudapi/ directory.

3. Call the BackupService.Delete method, e.g., via the following gRPCurl request:

   grpcurl \
     -format json \
     -import-path ~/cloudapi/ \
     -import-path ~/cloudapi/third_party/googleapis/ \
     -proto ~/cloudapi/yandex/cloud/mdb/postgresql/v1/backup_service.proto \
     -rpc-header "Authorization: Bearer $IAM_TOKEN" \
     -d '{
           "backup_id": "<backup_ID>"
         }' \
     mdb.api.cloud.yandex.net:443 \
     yandex.cloud.mdb.postgresql.v1.BackupService.Delete
   

   You can get the backup ID with the list of backups.

4. Check the server response to make sure your request was successful.