Updating MySQL® cluster settings

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 change the host class for a cluster:

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

   yc managed-mysql cluster update --help
   

2. Get the list of available host classes (the ZONE IDS column specifies the availability zones where you can select the appropriate class):

   yc managed-mysql resource-preset list
   

   Result:

   +-----------+--------------------------------+-------+----------+
   |    ID     |            ZONE IDS            | CORES |  MEMORY  |
   +-----------+--------------------------------+-------+----------+
   | s1.micro  | ru-central1-a, ru-central1-b,  |     2 | 8.0 GB   |
   |           | ru-central1-d                  |       |          |
   | ...                                                           |
   +-----------+--------------------------------+-------+----------+
   

3. Specify the class in the update cluster command:

   yc managed-mysql cluster update <cluster_name_or_ID>
     --resource-preset <class_ID>
   

   Managed Service for MySQL® will run the update host class command for the cluster.

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

   For more information about creating this file, see this guide.

2. In the Managed Service for MySQL® cluster description, edit the resource_preset_id parameter under resources:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     resources {
       resource_preset_id = "<host_class>"
       ...
     }
   }
   

3. Validate your configuration.

   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 resource changes.

   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.

For more information, see this Terraform provider guide.

resource "yandex_mdb_mysql_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 place 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-mysql/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.resources.resourcePresetId",
                 "configSpec": {
                   "resources": {
                     "resourcePresetId": "<host_class>"
                   }
                 }
               }'
   

   Where:

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

     Here, we provide only one setting.

   • configSpec.resources.resourcePresetId: New host class.

   You can request 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 place 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 the repository contents are stored 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/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.resources.resource_preset_id"
               ]
             },
             "config_spec": {
               "resources": {
                 "resource_preset_id": "<host_class>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of paths[] strings.

     Here, we provide only one setting.

   • config_spec.resources.resource_preset_id: New host class.

   You can get the cluster ID from the folder’s cluster list.

4. View 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 change the disk type and increase the storage size for a cluster:

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

   yc managed-mysql cluster update --help
   

2. Specify the disk type and required storage size in the cluster update command (at least as large as disk_size in the cluster properties):

   yc managed-mysql cluster update <cluster_name_or_ID> \
     --disk-type <disk_type> \
     --disk-size <storage_size_in_GB>
   

To change the disk type and increase the storage size for a cluster:

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

   For more information about creating this file, see this guide.

2. Under resources, change the disk_type_id and disk_size parameter values:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     resources {
       disk_type_id = "<disk_type>"
       disk_size    = <storage_size_in_GB>
       ...
     }
   }
   

3. Validate your configuration.

   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 resource changes.

   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.

For more information, see this Terraform provider guide.

resource "yandex_mdb_mysql_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 place 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-mysql/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.resources.diskTypeId,configSpec.resources.diskSize",
                 "configSpec": {
                   "resources": {
                     "diskTypeId": "<disk_type>",
                     "diskSize": "<storage_size_in_bytes>"
                   }
                 }
               }'
   

   Where:

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

   • configSpec.resources: Storage parameters:

     • diskTypeId: Disk type.
     • diskSize: New storage size in bytes.

   You can request 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 place 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 the repository contents are stored 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/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.resources.disk_type_id",
                 "config_spec.resources.disk_size"
               ]
             },
             "config_spec": {
               "resources": {
                 "disk_type_id": "<disk_type>",
                 "disk_size": "<storage_size_in_bytes>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of paths[] strings.

   • config_spec.resources: Storage parameters:

     • disk_type_id: Disk type.
     • disk_size: New storage size in bytes.

   You can request 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 update the MySQL® settings:

1. View the description of the CLI command to update the cluster configuration:

   yc managed-mysql cluster update-config --help
   

2. Set the required parameter values.

   All supported parameters are listed in the request format for the update method, in the mysql_config_5_7 field. To specify a parameter name in the CLI call, convert its name from lowerCamelCase to snake_case. For example, convert the logMinDurationStatement parameter from an API request to log_min_duration_statement for the CLI command:

   yc managed-mysql cluster update-config <cluster_name>
     --set log_min_duration_statement=100,<parameter_name>=<value>,...
   

   Managed Service for MySQL® runs the update cluster settings operation.

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

   For more information about creating this file, see this guide.

2. In the Managed Service for MySQL® cluster description, add or update the DBMS settings under mysql_config:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     mysql_config = {
       <MySQL®_setting_name> = <value>
       ...
     }
   }
   

3. Validate your configuration.

   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 resource changes.

   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.

For more information, see this Terraform provider guide.

resource "yandex_mdb_mysql_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 place 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-mysql/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "configSpec.mysqlConfig_<MySQL®_version>",
                 "configSpec": {
                   "mysqlConfig_<MySQL®_version>": {
                     "<setting_1>": "<value_1>",
                     "<setting_2>": "<value_2>",
                     ...
                     "<setting_N>": "<value_N>"
                   }
                 }
               }'
   

   Where:

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

     Here, we provide only one setting.

   • configSpec.mysqlConfig_<MySQL®_version>: MySQL® settings. Use a separate line for each setting; separate them by commas.

     See the method description for the list of MySQL® versions available for the parameter. See Cluster-level DBMS settings for a description and possible values for each setting.

   You can request 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 place 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 the repository contents are stored 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/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "config_spec.mysql_config_<MySQL®_version>"
               ]
             },
             "config_spec": {
               "mysql_config_<MySQL®_version>": {
                 "<setting_1>": "<value_1>",
                 "<setting_2>": "<value_2>",
                 ...
                 "<setting_N>": "<value_N>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of paths[] strings.

     Here, we provide only one setting.

   • configSpec.mysqlConfig_<MySQL®_version>: MySQL® settings. Use a separate line for each setting; separate them by commas.

     See the method description for the list of MySQL® versions available for the parameter. See Cluster-level DBMS settings for a description and possible values for each setting.

   You can get the cluster ID from the folder’s cluster list.

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 change additional cluster settings:

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

   yc managed-mysql cluster update --help
   

2. Run the following command with the list of settings to update:

   yc managed-mysql cluster update <cluster_name_or_ID> \
     --backup-window-start <backup_start_time> \
     --backup-retain-period-days=<backup_retention_period> \
     --datalens-access=<true_or_false> \
     --websql-access=<true_or_false> \
     --yandexquery-access=<true_or_false> \
     --disk-size-autoscaling disk-size-limit=<maximum_storage_size_in_GB>,`
                            `planned-usage-threshold=<threshold_for_scheduled_increase_in_percent>,`
                            `emergency-usage-threshold=<threshold_for_immediate_increase_in_percent> \
     --maintenance-window type=<maintenance_type>,`
                         `day=<day_of_week>,`
                         `hour=<hour> \
     --deletion-protection \
     --performance-diagnostics enabled=true,`
                              `sessions-sampling-interval=<session_sampling_interval>,`
                              `statements-sampling-interval=<statement_sampling_interval>
   

You can update the following settings:

• --backup-window-start: The cluster backup start time, set in UTC format HH:MM:SS. If the time is not set, the backup will start at 22:00 UTC.

• --backup-retain-period-days: Automatic backup retention period, in days. The valid values range from 7 to 60. The default value is 7.

• --datalens-access: Enables access to the cluster from DataLens. The default value is false. For more information about setting up a connection, see Connecting to a MySQL® cluster from DataLens.

• --websql-access: Enables SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL. The default value is false.

• --yandexquery-access: Enables YQL queries against cluster databases from Yandex Query. This feature is at the Preview stage. The default value is false.

• --disk-size-autoscaling: Automatic storage size increase settings:

  • planned-usage-threshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

    The valid values range from 0 to 100.

  • emergency-usage-threshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

    The valid values range from 0 to 100.

  • disk-size-limit: Maximum object size after increase, in GB.

  Warning

  • Automatic increase of storage size is not supported on dedicated hosts.

  • When using planned-usage-threshold, make sure to specify the --maintenance-window setting.

  • If you specify both thresholds, emergency-usage-threshold must be greater than planned-usage-threshold.

• --maintenance-window: Maintenance window settings (including for disabled clusters), where type is the maintenance type:

  • anytime: At any time (default).
  • weekly: On a schedule. For this value, also specify the following:
    • day: Day of week, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour of day (UTC), from 1 to 24.

• --deletion-protection: Cluster protection from accidental deletion, true or false.

  Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

• performance-diagnostics: Enabling statistics collection for cluster performance diagnostics. For sessions-sampling-interval and statements-sampling-interval, possible values range from 1 to 86400 seconds.

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

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

   For more information about creating this file, see this guide.

2. To change the backup start time, add a backup_window_start block to the Managed Service for MySQL® cluster description:

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

   Where:

   • hours: Backup start hour.
   • minutes: Backup start minute.

3. To change the backup retention period, specify the backup_retain_period_days parameter in the cluster description:

     resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
       ...
       backup_retain_period_days = <backup_retention_period>
       ...
     }
   

   Where backup_retain_period_days is automatic backup retention period, in days. The valid values range from 7 to 60. The default value is 7.

4. To enable access from DataLens and allow execution of SQL queries from the management console using Yandex WebSQL, add a section named access to the cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     access {
       data_lens = <true_or_false>
       web_sql   = <true_or_false>
     }
     ...
   }
   

5. To configure automatic increase of storage size, add the disk_size_autoscaling section to the cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     disk_size_autoscaling {
       disk_size_limit           = <maximum_storage_size_in_GB>
       emergency_usage_threshold = <threshold_for_immediate_increase_in_percent>
       planned_usage_threshold   = <threshold_for_scheduled_increase_in_percent>
     }
     ...
   }
   

   Where:

   • disk_size_limit: Maximum object size after increase, in gibibytes.

   • emergency_usage_threshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

     The valid values range from 0 to 100.

   • planned_usage_threshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

     The valid values range from 0 to 100.

   Warning

   • Automatic increase of storage size is not supported on dedicated hosts.

   • When using planned_usage_threshold, make sure to set the maintenance_window.

   • If you specify both thresholds, emergency_usage_threshold must be greater than planned_usage_threshold.

6. To set up the maintenance window (for disabled clusters as well), add the maintenance_window block to the cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     maintenance_window {
       type = <maintenance_type>
       day  = <day_of_week>
       hour = <hour>
     }
     ...
   }
   

   Where:

   • type: Maintenance type. The possible values include:
     • ANYTIME: Anytime
     • WEEKLY: On a schedule
   • day: Day of week for the WEEKLY type, i.e., MON, TUE, WED, THU, FRI, SAT, or SUN.
   • hour: UTC hour for the WEEKLY type, from 1 to 24.

7. To enable cluster protection against accidental deletion by a user of your cloud, add the deletion_protection field set to true to your cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     deletion_protection = <protect_cluster_from_deletion>
   }
   

   Where deletion_protection is protection against accidental cluster deletion: true or false.

   Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

8. To enable statistics collection for cluster performance diagnostics, add a performance_diagnostics block to your Managed Service for MySQL® cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     performance_diagnostics {
       enabled = true
       sessions_sampling_interval = <session_sampling_interval>
       statements_sampling_interval = <statement_sampling_interval>
     }
     ...
   }
   

   For sessions_sampling_interval and statements_sampling_interval, possible values range from 1 to 86400 seconds.

9. Validate your configuration.

   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.

10. Confirm resource changes.

    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.

For more information, see this Terraform provider guide.

resource "yandex_mdb_mysql_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 save it as an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

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

   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.

   {
       "updateMask": "configSpec.backupWindowStart,configSpec.backupRetainPeriodDays,configSpec.access,configSpec.performanceDiagnostics,maintenanceWindow,deletionProtection",
       "configSpec": {
           "backupWindowStart": {
               "hours": "<hours>",
               "minutes": "<minutes>",
               "seconds": "<seconds>",
               "nanos": "<nanoseconds>"
           },
           "backupRetainPeriodDays": "<number_of_days>",
           "access": {
               "dataLens": <allow_access_from_DataLens>,
               "webSql": <allow_access_from_WebSQL>,
               "yandexQuery": <allow_access_from_Yandex_Query>
           },
           "performanceDiagnostics": {
               "enabled": <enable_statistics_collection>,
               "sessionsSamplingInterval": "<session_sampling_interval>",
               "statementsSamplingInterval": "<statement_sampling_interval>"
           },
           "diskSizeAutoscaling": {
               "plannedUsageThreshold": "<threshold_for_scheduled_increase_in_percent>",
               "emergencyUsageThreshold": "<threshold_for_immediate_increase_in_percent>",
               "diskSizeLimit": "<maximum_storage_size_in_bytes>"
           }
       },
       "maintenanceWindow": {
           "weeklyMaintenanceWindow": {
               "day": "<day_of_week>",
               "hour": "<hour>"
           }
       },
       "deletionProtection": <protect_cluster_from_deletion>
   }
   

   Where:

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

   • configSpec: Cluster settings:

     • backupWindowStart: Backup window settings.

       In this parameter, specify the backup start time:

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

     • backupRetainPeriodDays: Number of days to retain the cluster backup, between 7 and 60.

     • access: Settings for cluster access from Yandex Cloud services:

       • dataLens: Access from DataLens. For more information about setting up a connection, see Connecting from DataLens.
       • webSql: SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL.
       • yandexQuery: YQL queries against cluster databases from Yandex Query. This feature is currently in Preview.

       The possible setting values are true or false.

     • performanceDiagnostics: Statistics collection settings:

       • enabled: Enables statistics collection, true or false.
       • sessionsSamplingInterval: Session sampling interval, from 1 to 86400 seconds.
       • statementsSamplingInterval: Statement sampling interval, from 1 to 86400 seconds.

     • diskSizeAutoscaling: Automatic storage size increase settings:

       • plannedUsageThreshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

         The valid values range from 0 to 100.

       • emergencyUsageThreshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

         The valid values range from 0 to 100.

       • diskSizeLimit: Maximum object size after increase, in bytes.

       Warning

       • Automatic increase of storage size is not supported on dedicated hosts.

       • When using plannedUsageThreshold, make sure to specify the maintenanceWindow setting.

       • If you specify both thresholds, emergencyUsageThreshold must be greater than plannedUsageThreshold.

   • maintenanceWindow: Maintenance window settings (including for disabled clusters). Provide one of these parameters:

     • anytime (default): Maintenance can take place at any time.

     • weeklyMaintenanceWindow: Scheduled maintenance:

       • day: Day of week, in DDD format. Valid values: MON, TUE, WED, THU, FRI, SAT, SUN.
       • hour: Time of day (UTC) in HH format. The valid values range from 1 to 24.

   • deletionProtection: Cluster protection from accidental deletion, true or false.

     Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

3. Use the Cluster.update method and send the following request, e.g., via cURL:

   curl \
       --request PATCH \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>' \
       --data "@body.json"
   

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

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

1. Get an IAM token for API authentication and save it as 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 the repository contents are stored in the ~/cloudapi/ directory.

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

   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>"
       ]
   }
   

   {
       "cluster_id": "<cluster_ID>",
       "update_mask": {
           "paths": [
               "config_spec.backup_window_start",
               "config_spec.backup_retain_period_days",
               "config_spec.access",
               "config_spec.performance_diagnostics",
               "maintenance_window",
               "deletion_protection"
           ]
       },
       "config_spec": {
           "backup_window_start": {
               "hours": "<hours>",
               "minutes": "<minutes>",
               "seconds": "<seconds>",
               "nanos": "<nanoseconds>"
           },
           "backup_retain_period_days": "<number_of_days>",
           "access": {
               "data_lens": <allow_access_from_DataLens>,
               "web_sql": <allow_access_from_WebSQL>,
               "yandex_query": <allow_access_from_Yandex_Query>
           },
           "performance_diagnostics": {
               "enabled": <enable_statistics_collection>,
               "sessions_sampling_interval": "<session_sampling_interval>",
               "statements_sampling_interval": "<statement_sampling_interval>"
           },
           "disk_size_autoscaling": {
               "planned_usage_threshold": "<threshold_for_scheduled_increase_in_percent>",
               "emergency_usage_threshold": "<threshold_for_immediate_increase_in_percent>",
               "disk_size_limit": "<maximum_storage_size_in_bytes>"
           }
       },
       "maintenance_window": {
           "weekly_maintenance_window": {
               "day": "<day_of_week>",
               "hour": "<hour>"
           }
       },
       "deletion_protection": <protect_cluster_from_deletion>
   }
   

   Where:

   • update_mask: List of settings you want to update as an array of paths[] strings.

   • config_spec: Cluster settings:

     • backup_window_start: Backup window settings.

       In this parameter, specify the backup start time:

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

     • backup_retain_period_days: Number of days to retain the cluster backup, between 7 and 60.

     • access: Settings for cluster access from Yandex Cloud services:

       • data_lens: Access from DataLens. For more information about setting up a connection, see Connecting from DataLens.
       • web_sql: SQL queries against cluster databases from the Yandex Cloud management console using Yandex WebSQL.
       • yandex_query: YQL queries against cluster databases from Yandex Query. This feature is currently in Preview.

       The possible setting values are true or false.

     • performance_diagnostics: Statistics collection settings:

       • enabled: Enables statistics collection, true or false.
       • sessions_sampling_interval: Session sampling interval, from 1 to 86400 seconds.
       • statements_sampling_interval: Statement sampling interval, from 1 to 86400 seconds.

     • disk_size_autoscaling: Automatic storage size increase settings:

       • planned_usage_threshold: Storage utilization threshold to trigger a storage increase during the next maintenance window, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

         The valid values range from 0 to 100.

       • emergency_usage_threshold: Storage utilization threshold to trigger a storage increase right away, in percent. This is an optional setting. The default setting is 0 (automatic increase disabled).

         The valid values range from 0 to 100.

       • disk_size_limit: Maximum object size after increase, in bytes.

       Warning

       • Automatic increase of storage size is not supported on dedicated hosts.

       • When using planned_usage_threshold, make sure to specify the maintenance_window setting.

       • If you specify both thresholds, emergency_usage_threshold must be greater than planned_usage_threshold.

   • maintenance_window: Maintenance window settings (including for disabled clusters). Provide one of these parameters:

     • anytime (default): Maintenance can take place at any time.

     • weekly_maintenance_window: Scheduled maintenance:

       • day: Day of week, in DDD format. Valid values: MON, TUE, WED, THU, FRI, SAT, SUN.
       • hour: Time of day (UTC) in HH format. The valid values range from 1 to 24.

   • deletion_protection: Cluster protection from accidental deletion, true or false.

     Even with cluster deletion protection enabled, one can still delete a user or database or connect manually and delete the database contents.

   You can get the cluster ID from the folder’s cluster list.

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

   grpcurl \
       -format json \
       -import-path ~/cloudapi/ \
       -import-path ~/cloudapi/third_party/googleapis/ \
       -proto ~/cloudapi/yandex/cloud/mdb/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d @ \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.Update \
       < 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.

Run this command:

yc managed-mysql cluster start-failover <cluster_name_or_ID> \
    --host <replica_host_name>

You can request the replica host name with the list of cluster hosts and the cluster name with the list of clusters in the folder.

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

   export IAM_TOKEN="<IAM_token>"
   

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

   curl \
     --request POST \
     --header "Authorization: Bearer $IAM_TOKEN" \
     --header "Content-Type: application/json" \
     --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>:startFailover' \
     --data '{
               "hostName": "<host_FQDN>"
             }'
   

   Where hostName is the FQDN of the replica which becomes the master host.

   You can get the cluster ID from the folder’s cluster list.

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

1. Get an IAM token for API authentication and place 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 the repository contents are stored in the ~/cloudapi/ directory.

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

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

   Where host_name is the FQDN of the replica which becomes the master host.

   You can get the cluster ID from the folder’s cluster list.

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 move a cluster:

1. See the description of the CLI command for moving a cluster:

   yc managed-mysql cluster move --help
   

2. Specify the destination folder in that command:

   yc managed-mysql cluster move <cluster_ID> \
      --destination-folder-name=<destination_folder_name>
   

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

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

   For more information about creating this file, see this guide.

2. In the Managed Service for MySQL® cluster description, edit or add the folder_id value:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     folder_id = "<destination_folder_ID>"
   }
   

3. Validate your configuration.

   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 resource changes.

   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.

For more information, see this Terraform provider guide.

resource "yandex_mdb_mysql_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 place it in an environment variable:

   export IAM_TOKEN="<IAM_token>"
   

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

   curl \
       --request POST \
       --header "Authorization: Bearer $IAM_TOKEN" \
       --header "Content-Type: application/json" \
       --url 'https://mdb.api.cloud.yandex.net/managed-mysql/v1/clusters/<cluster_ID>:move' \
       --data '{
                 "destinationFolderId": "<folder_ID>"
               }'
   

   Where destinationFolderId is the ID of the folder you want to move your cluster to. You can fetch this ID together with the list of folders in the cloud.

   You can request 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 place 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 the repository contents are stored in the ~/cloudapi/ directory.

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

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

   Where destination_folder_id is the ID of the folder you want to move your cluster to. You can fetch this ID together with the list of folders in the cloud.

   You can get the cluster ID from the folder’s cluster list.

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 edit the list of security groups for your cluster:

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

   yc managed-mysql cluster update --help
   

2. Specify the security groups in that command:

   yc managed-mysql cluster update <cluster_name_or_ID> \
     --security-group-ids <list_of_security_group_IDs>
   

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

   For more information about creating this file, see this guide.

2. Edit the security_group_ids parameter in the Managed Service for MySQL® cluster description:

   resource "yandex_mdb_mysql_cluster" "<cluster_name>" {
     ...
     security_group_ids = [<list_of_security_group_IDs>]
   }
   

3. Validate your configuration.

   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 resource changes.

   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.

For more information, see this Terraform provider guide.

resource "yandex_mdb_mysql_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 place 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-mysql/v1/clusters/<cluster_ID>' \
       --data '{
                 "updateMask": "securityGroupIds",
                   "securityGroupIds": [
                     "<security_group_1_ID>",
                     "<security_group_2_ID>",
                     ...
                     "<security_group_N_ID>"
                   ]
               }'
   

   Where:

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

     Here, we provide only one setting.

   • securityGroupIds: New list of security groups presented in the form of array elements.

   You can request 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 place 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 the repository contents are stored 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/mysql/v1/cluster_service.proto \
       -rpc-header "Authorization: Bearer $IAM_TOKEN" \
       -d '{
             "cluster_id": "<cluster_ID>",
             "update_mask": {
               "paths": [
                 "security_group_ids"
               ]
             },
             "security_group_ids": [
               "<security_group_1_ID>",
               "<security_group_2_ID>",
               ...
               "<security_group_N_ID>"
             ]
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.Update
   

   Where:

   • update_mask: List of settings you want to update as an array of paths[] strings.

     Here, we provide only one setting.

   • security_group_ids: New list of security groups presented in the form of array elements.

   You can get the cluster ID from the folder’s cluster list.

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