Updated on 2023-11-27 GMT+08:00

Modifying RDS for SQL Server Instance Parameters

You can modify parameters in a custom parameter template to optimize RDS database performance.

You can only change parameter values in custom parameter templates. You cannot change the parameter values in default parameter templates.

The following are the key points you should know when using parameters:

  • Modifying instance parameters: When you modify dynamic parameters on the Parameters page of a DB instance and save the modifications, the modifications take effect immediately regardless of the Effective upon Reboot setting. However, when you modify static parameters on the Parameters page of a DB instance and save the modifications, the modifications do not take effect until you manually reboot the DB instance.
  • Modifying parameter template parameters: When you modify parameters in a custom parameter template on the Parameter Templates page and save the modifications, the modifications do not take effect until you have applied the template to your DB instances. For operation details, see Applying a Parameter Template. When you modify static parameters in a custom parameter template on the Parameter Templates page and save the modifications, the modifications do not take effect until you have applied the template to your DB instances and manually rebooted those DB instances.

When you modify a parameter, the time when the modification takes effect depends on the type of the parameter.

The RDS console displays the statuses of DB instances that the parameter template applies to. For example, if the DB instance has not yet used the latest modifications made to its parameter template, its status is Parameter change. Pending reboot. Manually reboot the DB instance for the latest modifications to take effect for that DB instance.

RDS has default parameter templates whose parameter values cannot be changed. You can view these parameter values by clicking the default parameter templates. If a custom parameter template is set incorrectly, the database startup may fail. If this happens, you can re-configure the custom parameter template based on the settings of the default parameter template.

Modifying a Custom Parameter Template and Applying It to DB Instances

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Relational Database Service.
  4. Choose Parameter Templates in the navigation pane on the left. On the Custom Templates page, click the target parameter template.
  5. On the Parameters page, modify parameters as required.

    Relevant parameters are as follows:

    • Set remote access to 0 (default value) to prevent locally stored procedures from running on a remote server and remotely stored procedures from running on a local server.

    Available operations are as follows:

    • To save the modifications, click Save.
    • To cancel the modifications, click Cancel.
    • To preview the modifications, click Preview.

  6. After the parameter values are modified, you can click Change History to view the modification details.
  7. Apply the parameter template to your DB instance. For details, see Applying a Parameter Template.
  8. View the status of the DB instance to which the parameter template was applied.

    If the DB instance status is Parameter change. Pending reboot, a reboot is required for the modifications to take effect.

    • A DB instance reboot caused by instance class changes will not make parameter modifications take effect.
    • If you have modified parameters of a primary DB instance, you need to reboot the primary DB instance for the modifications to take effect. (For primary/standby DB instances, the parameter modifications are also applied to the standby DB instance.)
    • If you have modified parameters of a read replica, you need to reboot the read replica for the modifications to take effect.

Modifying Instance Parameters

  1. Log in to the management console.
  2. Click in the upper left corner and select a region and a project.
  3. Click in the upper left corner of the page and choose Databases > Relational Database Service.
  4. On the Instances page, click the target DB instance.
  5. In the navigation pane on the left, choose Parameters. On the displayed page, modify parameters as required.

    Relevant parameters are as follows:
    • Set remote access to 0 (default value) to prevent locally stored procedures from running on a remote server and remotely stored procedures from running on a local server.

    Available operations are Save, Cancel, and Preview.

    • To save the modifications, click Save.
    • To cancel the modifications, click Cancel.
    • To preview the modifications, click Preview.
    In the Effective upon Reboot column:
    • If the value is Yes and the DB instance status on the Instances page is Parameter change. Pending reboot, a reboot is required the modifications to take effect.
      • If you have modified parameters of a primary DB instance, you need to reboot the primary DB instance for the modifications to take effect. (For primary/standby DB instances, the parameter modifications are also applied to the standby DB instance.)
      • If you have modified parameters of a read replica, you need to reboot the read replica for the modifications to take effect.
    • If the value is No, the modifications take effect immediately.

    After parameters are modified, you can view parameter change history by referring to section Viewing Parameter Change History.

Common Parameters

Table 1 Common parameters

Parameter

Description

Reference

remote query timeout

The remote query timeout option, which specifies how long, in seconds, a remote operation can take before RDS for SQL Server times out.

Will I Be Logged Out If the Connection to RDS for SQL Server Instances Times Out?