Updating MySQL® cluster settings

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change the host class for the cluster:

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

   yc managed-mysql cluster update --help
   

2. Request a 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 with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

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

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

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.update method and make a 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: List of parameters to update as a single string, separated by commas.

     In this case, only one parameter is provided.

   • configSpec.resources.resourcePresetId: New host class.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 make a 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 parameters to update as an array of paths[] strings.

     In this case, only one parameter is provided.

   • config_spec.resources.resource_preset_id: New host class.

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

4. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To increase the cluster storage size:

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

   yc managed-mysql cluster update --help
   

2. Specify the required storage in the cluster update command (it must be at least as large as disk_size in the cluster properties):

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

To increase the cluster storage size:

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

2. Under resources, change the disk_size parameter value:

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

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.update method and make a 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.diskSize",
                 "configSpec": {
                   "resources": {
                     "diskSize": "<storage_size_in_bytes>"
                   }
                 }
               }'
   

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

     In this case, only one parameter is provided.

   • configSpec.resources.diskSize: New disk size in bytes.

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 make a 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_size"
               ]
             },
             "config_spec": {
               "resources": {
                 "disk_size": "<storage_size_in_bytes>"
               }
             }
           }' \
       mdb.api.cloud.yandex.net:443 \
       yandex.cloud.mdb.mysql.v1.ClusterService.Update
   

   Where:

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

     In this case, only one parameter is provided.

   • config_spec.resources.disk_size: New disk size in bytes.

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

4. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To update the MySQL® settings:

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

   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 with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

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. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.update method and make a 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: List of parameters to update as a single string, separated by commas.

     In this case, only one parameter is provided.

   • 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 with a list of clusters in the folder.

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 make a 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 parameters to update as an array of paths[] strings.

     In this case, only one parameter is provided.

   • 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 with a list of clusters in the folder.

4. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To change additional cluster settings:

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

   yc managed-mysql cluster update --help
   

2. Run the following command with a 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> \
     --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 change 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 possible values range from 7 to 60. The default value is 7.

• --datalens-access: Enables access from DataLens. The default value is false. For more information about how to connect to DataLens, 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.

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

  • anytime (default): Any time.
  • weekly: On a schedule. If setting this value, specify the day of week and the hour:
    • day: Day of week in DDD format: MON, TUE, WED, THU, FRI, SAT, or SUN.
    • hour: Hour (UTC) in HH format: 1 to 24.

• --deletion-protection: Protection of the cluster, its databases, and users against accidental deletion.

  Enabled deletion protection will not prevent a manual connection with the purpose to delete 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 a list of clusters in the folder.

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

2. To change the backup start time, add a backup_window_start section 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 the automatic backup retention period, in days. The possible 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 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: By schedule.
   • day: Day of the week for the weekly type in DDD format, e.g., MON.
   • hour: Hour of the day for the weekly type in the HH format, e.g., 21.

6. 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 = <deletion_protection>
   }
   

   Where deletion_protection is the cluster deletion protection, true or false.

   Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

7. To enable statistics collection for cluster performance diagnostics, add the performance_diagnostics section 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.

8. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

9. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Create a file named body.json and add the following contents to 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": <access_to_DataLens:_true_or_false>,
               "webSql": <access_to_WebSQL:_true_or_false>,
               "dataTransfer": <access_to_Data_Transfer:_true_or_false>
           },
           "performanceDiagnostics": {
               "enabled": <activate_statistics_collection:_true_or_false>,
               "sessionsSamplingInterval": "<session_sampling_interval>",
               "statementsSamplingInterval": "<statement_sampling_interval>"
           }
       },
       "maintenanceWindow": {
           "weeklyMaintenanceWindow": {
               "day": "<day_of_week>",
               "hour": "<hour>"
           }
       },
       "deletionProtection": <deletion_protection:_true_or_false>
   }
   

   Where:

   • updateMask: List of parameters to update as a single string, separated by commas.

   • 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, 7 to 60 days.

     • access: Settings for cluster access to the following Yandex Cloud services:

       • dataLens: Yandex DataLens
       • webSql: Yandex WebSQL
       • dataTransfer: Yandex Data Transfer

     • performanceDiagnostics: Settings for collecting statistics:

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

   • maintenanceWindow: Maintenance window settings (including for disabled clusters). In maintenanceWindow, provide one of the two parameters:

     • anytime: Maintenance can take place at any time.

     • weeklyMaintenanceWindow: Maintenance takes place once a week at the specified time:

       • day: Day of week, in DDD format.
       • hour: Hour, in HH format. The values range from 1 to 24 hours.

   • deletionProtection: Protection of the cluster, its databases, and users against deletion.

     By default, the parameter inherits its value from the cluster when creating users and databases. You can also set the value manually; for more information, see the User management and Database management sections.

     If the parameter is changed on a running cluster, only users and databases with the Same as cluster protection will inherit the new value.

     Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

3. Use the Cluster.update method and make a 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 get the cluster ID with a list of clusters in the folder.

4. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 add the following contents to 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": <access_to_DataLens:_true_or_false>,
               "web_sql": <access_to_WebSQL:_true_or_false>,
               "data_transfer": <access_to_Data_Transfer:_true_or_false>
           },
           "performance_diagnostics": {
               "enabled": <activate_statistics_collection:_true_or_false>,
               "sessions_sampling_interval": "<session_sampling_interval>",
               "statements_sampling_interval": "<statement_sampling_interval>"
           }
       },
       "maintenance_window": {
           "weekly_maintenance_window": {
               "day": "<day_of_week>",
               "hour": "<hour>"
           }
       },
       "deletion_protection": <deletion_protection:_true_or_false>
   }
   

   Where:

   • update_mask: List of parameters 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, 7 to 60 days.

     • access: Settings for cluster access to the following Yandex Cloud services:

       • data_lens: Yandex DataLens
       • web_sql: Yandex WebSQL
       • data_transfer: Yandex Data Transfer

     • performance_diagnostics: Settings for collecting statistics:

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

   • maintenance_window: Maintenance window settings (including for disabled clusters). In maintenance_window, provide one of the two parameters:

     • anytime: Maintenance can take place at any time.

     • weekly_maintenance_window: Maintenance takes place once a week at the specified time:

       • day: Day of week, in DDD format.
       • hour: Hour, in HH format. The values range from 1 to 24 hours.

   • deletion_protection: Protection of the cluster, its databases, and users against deletion.

     By default, the parameter inherits its value from the cluster when creating users and databases. You can also set the value manually; for more information, see the User management and Database management sections.

     If the parameter is changed on a running cluster, only users and databases with the Same as cluster protection will inherit the new value.

     Enabled deletion protection will not prevent a manual connection with the purpose to delete database contents.

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

4. Use the ClusterService/Update call and make a 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. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To move a cluster:

1. View the description of the CLI move cluster command:

   yc managed-mysql cluster move --help
   

2. Specify the destination folder in the move cluster command:

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

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

1. Open the current Terraform configuration file with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

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

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

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.move method and make a 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 get the cluster ID with a list of clusters in the folder.

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 make a 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 with a list of clusters in the folder.

4. View the server response to make sure the request was successful.

If you do not have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To edit the list of security groups for your cluster:

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

   yc managed-mysql cluster update --help
   

2. Specify the security groups in the update cluster 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 with an infrastructure plan.

   For more information about creating this file, see Creating clusters.

2. In the Managed Service for MySQL® cluster description, change the security_group_ids parameter value:

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

3. Make sure the settings are correct.

   1. Using the command line, navigate to the folder that contains the up-to-date Terraform configuration files with an infrastructure plan.

   2. Run the command:

      terraform validate
      

      If there are errors in the configuration files, Terraform will point to them.

4. Confirm updating the resources.

   1. Run the command to view planned changes:

      terraform plan
      

      If the resource configuration descriptions are correct, the terminal will display a list of the resources to modify and their parameters. This is a test step. No resources are updated.

   2. If you are happy with the planned changes, apply them:

      1. Run the command:

         terraform apply
         

      2. Confirm the update of resources.

      3. Wait for the operation to complete.

For more information, see the Terraform provider documentation.

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 put it into the environment variable:

   export IAM_TOKEN="<IAM_token>"
   

2. Use the Cluster.update method and make a 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: List of parameters to update as a single string, separated by commas.

     In this case, only one parameter is provided.

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

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

3. View the server response to make sure the request was successful.

1. Get an IAM token for API authentication and put it into the 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 make a 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 parameters to update as an array of paths[] strings.

     In this case, only one parameter is provided.

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

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

4. View the server response to make sure the request was successful.