Help Center/ Document Database Service/ User Guide/ Parameter Template Management/ Creating a Parameter Template
Updated on 2025-09-10 GMT+08:00
View PDF

Creating a Parameter Template

Scenarios

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

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.

Cluster

  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 > Document Database Service.
  4. In the navigation pane on the left, choose Parameter Templates.
  5. On the Parameter Templates page, click Create Parameter Template.
  6. 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 the following special characters >!<"&'=

  7. On the Parameter Templates page, view and manage parameter templates on the Clusters tab.

Replica Set

  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 > Document Database Service.
  4. In the navigation pane on the left, choose Parameter Templates.
  5. On the Parameter Templates page, click Create Parameter Template.
  6. 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 the following special characters >!<"&'=

  7. On the Parameter Templates page, view and manage parameter templates on the Replica Sets tab.

Single Node

  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 > Document Database Service.
  4. In the navigation pane on the left, choose Parameter Templates.
  5. On the Parameter Templates page, click Create Parameter Template.
  6. 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 the following special characters >!<"&'=

  7. On the Parameter Templates page, view and manage parameter templates on the Single Nodes tab.