Creating a Parameter Template

Scenarios

You can use database parameter templates to manage DB engine configurations. A database parameter template acts as a container for engine configuration values that can be applied to one or more DB instances.

If you create a DB instance without specifying a custom parameter template, the system uses a default one for the instance. Each default parameter template contains DB engine defaults and system defaults that are configured based on the engine, compute class, and storage space allocated of an instance. Parameters in default parameter templates cannot be modified. You need to create your own parameter template to change parameter settings.

If you want to use a custom parameter template, simply create a parameter template and select it when you create an instance or apply it to an existing instance by following the instructions provided in Applying a Parameter Template.

When you have already created a parameter template and want to include most of the custom parameters and values from that template in a new parameter template, you can replicate that parameter template following the instructions provided in Replicating a Parameter Template.

Precautions

DDS does not share parameter template quotas with RDS.
Each account can create up to 100 DDS parameter templates for the cluster, replica set, and single node instances.

Procedure

Log in to the management console.
Click in the upper left corner and select a region and a project.
Click in the upper left corner of the page and choose Databases > Document Database Service.
In the navigation pane on the left, choose Parameter Templates.
On the Parameter Templates page, click Create Parameter Template.
Select Cluster for DB Instance Type, specify DB Engine Version, Node Type, New Parameter Template, and Description (optional), and then click OK.
- Node Type: specifies the node type that this parameter template will apply to. For example, to create a parameter template applying to config, select config.
- New Parameter Template: The template name can be up to 64 characters. It must start with a letter and can contain only letters (case-sensitive), digits, hyphens (-), periods (.), and underscores (_).
- Description: It can contain up to 256 characters but cannot contain line breaks or other special characters (>!<"&'=).
On the Parameter Templates page, view and manage parameter templates on the Clusters tab.

Log in to the management console.
Click in the upper left corner and select a region and a project.
Click in the upper left corner of the page and choose Databases > Document Database Service.
In the navigation pane on the left, choose Parameter Templates.
On the Parameter Templates page, click Create Parameter Template.
Select Replica set for DB Instance Type, specify DB Engine Version, Node Type, Parameter Template Name, and Description (optional), and then click OK.
- Node Type: specifies the node type that this parameter template will apply to. For example, to create a parameter template applying to a read replica, select readonly.
- New Parameter Template: The template name can be up to 64 characters. It must start with a letter and can contain only letters (case-sensitive), digits, hyphens (-), periods (.), and underscores (_).
- Description: It can contain up to 256 characters but cannot contain line breaks or other special characters (>!<"&'=).
On the Parameter Templates page, view and manage parameter templates on the Replica Sets tab.

Log in to the management console.
Click in the upper left corner and select a region and a project.
Click in the upper left corner of the page and choose Databases > Document Database Service.
In the navigation pane on the left, choose Parameter Templates.
On the Parameter Templates page, click Create Parameter Template.
Select Single node for DB Instance Type, specify DB Engine Version, New Parameter Template, and Description (optional), and then click OK.
- New Parameter Template: The template name can be up to 64 characters. It must start with a letter and can contain only letters (case-sensitive), digits, hyphens (-), periods (.), and underscores (_).
- Description: It can contain up to 256 characters but cannot contain line breaks or other special characters (>!<"&'=).
On the Parameter Templates page, view and manage parameter templates on the Single Nodes tab.