1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. rdsmysql
  6. ParameterTemplate
Viewing docs for volcenginecc v0.0.35
published on Thursday, May 14, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.rdsmysql.ParameterTemplate

volcenginecc logo
Viewing docs for volcenginecc v0.0.35
published on Thursday, May 14, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    Volcano Engine Cloud Database MySQL version parameter template for managing and applying MySQL instance parameter configurations in bulk

    Example Usage

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    Example coming soon!

    resources:
  rDSMySQLParameterTemplateDemo:
    type: volcenginecc:rdsmysql:ParameterTemplate
    name: RDSMySQLParameterTemplateDemo
    properties:
      templateName: test-parametertemplate
      templateType: Mysql
      templateTypeVersion: MySQL_5_7
      templateParams:
        - name: auto_increment_increment
          running_value: '33'
        - name: automatic_sp_privileges
          running_value: on
      templateDesc: 测试参数模板
      engineType: InnoDB
      projectName: default

    Example coming soon!

    Create ParameterTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ParameterTemplate(name: string, args: ParameterTemplateArgs, opts?: CustomResourceOptions);
    @overload
def ParameterTemplate(resource_name: str,
                      args: ParameterTemplateArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ParameterTemplate(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      template_name: Optional[str] = None,
                      template_params: Optional[Sequence[ParameterTemplateTemplateParamArgs]] = None,
                      engine_type: Optional[str] = None,
                      project_name: Optional[str] = None,
                      template_desc: Optional[str] = None,
                      template_type: Optional[str] = None,
                      template_type_version: Optional[str] = None)
    func NewParameterTemplate(ctx *Context, name string, args ParameterTemplateArgs, opts ...ResourceOption) (*ParameterTemplate, error)
    public ParameterTemplate(string name, ParameterTemplateArgs args, CustomResourceOptions? opts = null)
    public ParameterTemplate(String name, ParameterTemplateArgs args)
public ParameterTemplate(String name, ParameterTemplateArgs args, CustomResourceOptions options)

    type: volcenginecc:rdsmysql:ParameterTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "volcenginecc_rdsmysql_parametertemplate" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args ParameterTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ParameterTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ParameterTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ParameterTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ParameterTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var parameterTemplateResource = new Volcenginecc.Rdsmysql.ParameterTemplate("parameterTemplateResource", new()
{
    TemplateName = "string",
    TemplateParams = new[]
    {
        new Volcenginecc.Rdsmysql.Inputs.ParameterTemplateTemplateParamArgs
        {
            Name = "string",
            RunningValue = "string",
        },
    },
    EngineType = "string",
    ProjectName = "string",
    TemplateDesc = "string",
    TemplateType = "string",
    TemplateTypeVersion = "string",
});

    example, err := rdsmysql.NewParameterTemplate(ctx, "parameterTemplateResource", &rdsmysql.ParameterTemplateArgs{
	TemplateName: pulumi.String("string"),
	TemplateParams: rdsmysql.ParameterTemplateTemplateParamArray{
		&rdsmysql.ParameterTemplateTemplateParamArgs{
			Name:         pulumi.String("string"),
			RunningValue: pulumi.String("string"),
		},
	},
	EngineType:          pulumi.String("string"),
	ProjectName:         pulumi.String("string"),
	TemplateDesc:        pulumi.String("string"),
	TemplateType:        pulumi.String("string"),
	TemplateTypeVersion: pulumi.String("string"),
})

    resource "volcenginecc_rdsmysql_parametertemplate" "parameterTemplateResource" {
  template_name = "string"
  template_params {
    name          = "string"
    running_value = "string"
  }
  engine_type           = "string"
  project_name          = "string"
  template_desc         = "string"
  template_type         = "string"
  template_type_version = "string"
}

    var parameterTemplateResource = new ParameterTemplate("parameterTemplateResource", ParameterTemplateArgs.builder()
    .templateName("string")
    .templateParams(ParameterTemplateTemplateParamArgs.builder()
        .name("string")
        .runningValue("string")
        .build())
    .engineType("string")
    .projectName("string")
    .templateDesc("string")
    .templateType("string")
    .templateTypeVersion("string")
    .build());

    parameter_template_resource = volcenginecc.rdsmysql.ParameterTemplate("parameterTemplateResource",
    template_name="string",
    template_params=[{
        "name": "string",
        "running_value": "string",
    }],
    engine_type="string",
    project_name="string",
    template_desc="string",
    template_type="string",
    template_type_version="string")

    const parameterTemplateResource = new volcenginecc.rdsmysql.ParameterTemplate("parameterTemplateResource", {
    templateName: "string",
    templateParams: [{
        name: "string",
        runningValue: "string",
    }],
    engineType: "string",
    projectName: "string",
    templateDesc: "string",
    templateType: "string",
    templateTypeVersion: "string",
});

    type: volcenginecc:rdsmysql:ParameterTemplate
properties:
    engineType: string
    projectName: string
    templateDesc: string
    templateName: string
    templateParams:
        - name: string
          runningValue: string
    templateType: string
    templateTypeVersion: string

    ParameterTemplate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ParameterTemplate resource accepts the following input properties:

    TemplateName string
    Parameter template name
    TemplateParams List<Volcengine.ParameterTemplateTemplateParam>
    EngineType string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    ProjectName string
    Associated project
    TemplateDesc string
    Parameter template description
    TemplateType string
    Database type of the parameter template. Default: Mysql
    TemplateTypeVersion string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    TemplateName string
    Parameter template name
    TemplateParams []ParameterTemplateTemplateParamArgs
    EngineType string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    ProjectName string
    Associated project
    TemplateDesc string
    Parameter template description
    TemplateType string
    Database type of the parameter template. Default: Mysql
    TemplateTypeVersion string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    template_name string
    Parameter template name
    template_params list(object)
    engine_type string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    project_name string
    Associated project
    template_desc string
    Parameter template description
    template_type string
    Database type of the parameter template. Default: Mysql
    template_type_version string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    templateName String
    Parameter template name
    templateParams List<ParameterTemplateTemplateParam>
    engineType String
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    projectName String
    Associated project
    templateDesc String
    Parameter template description
    templateType String
    Database type of the parameter template. Default: Mysql
    templateTypeVersion String
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    templateName string
    Parameter template name
    templateParams ParameterTemplateTemplateParam[]
    engineType string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    projectName string
    Associated project
    templateDesc string
    Parameter template description
    templateType string
    Database type of the parameter template. Default: Mysql
    templateTypeVersion string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    template_name str
    Parameter template name
    template_params Sequence[ParameterTemplateTemplateParamArgs]
    engine_type str
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    project_name str
    Associated project
    template_desc str
    Parameter template description
    template_type str
    Database type of the parameter template. Default: Mysql
    template_type_version str
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    templateName String
    Parameter template name
    templateParams List<Property Map>
    engineType String
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    projectName String
    Associated project
    templateDesc String
    Parameter template description
    templateType String
    Database type of the parameter template. Default: Mysql
    templateTypeVersion String
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ParameterTemplate resource produces the following output properties:

    AccountId string
    Account ID
    CreateTime string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    Id string
    The provider-assigned unique ID for this managed resource.
    NeedRestart bool
    Whether the template contains parameters that require a restart
    ParameterNum int
    Number of parameters included in the template
    TemplateCategory string
    Template category. Value: DBEngine (database engine parameter)
    TemplateId string
    Parameter template ID, automatically generated by the system
    TemplateSource string
    Parameter template type. Values: System (system template), User (user template)
    UpdateTime string
    Template modification time
    AccountId string
    Account ID
    CreateTime string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    Id string
    The provider-assigned unique ID for this managed resource.
    NeedRestart bool
    Whether the template contains parameters that require a restart
    ParameterNum int
    Number of parameters included in the template
    TemplateCategory string
    Template category. Value: DBEngine (database engine parameter)
    TemplateId string
    Parameter template ID, automatically generated by the system
    TemplateSource string
    Parameter template type. Values: System (system template), User (user template)
    UpdateTime string
    Template modification time
    account_id string
    Account ID
    create_time string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    id string
    The provider-assigned unique ID for this managed resource.
    need_restart bool
    Whether the template contains parameters that require a restart
    parameter_num number
    Number of parameters included in the template
    template_category string
    Template category. Value: DBEngine (database engine parameter)
    template_id string
    Parameter template ID, automatically generated by the system
    template_source string
    Parameter template type. Values: System (system template), User (user template)
    update_time string
    Template modification time
    accountId String
    Account ID
    createTime String
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    id String
    The provider-assigned unique ID for this managed resource.
    needRestart Boolean
    Whether the template contains parameters that require a restart
    parameterNum Integer
    Number of parameters included in the template
    templateCategory String
    Template category. Value: DBEngine (database engine parameter)
    templateId String
    Parameter template ID, automatically generated by the system
    templateSource String
    Parameter template type. Values: System (system template), User (user template)
    updateTime String
    Template modification time
    accountId string
    Account ID
    createTime string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    id string
    The provider-assigned unique ID for this managed resource.
    needRestart boolean
    Whether the template contains parameters that require a restart
    parameterNum number
    Number of parameters included in the template
    templateCategory string
    Template category. Value: DBEngine (database engine parameter)
    templateId string
    Parameter template ID, automatically generated by the system
    templateSource string
    Parameter template type. Values: System (system template), User (user template)
    updateTime string
    Template modification time
    account_id str
    Account ID
    create_time str
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    id str
    The provider-assigned unique ID for this managed resource.
    need_restart bool
    Whether the template contains parameters that require a restart
    parameter_num int
    Number of parameters included in the template
    template_category str
    Template category. Value: DBEngine (database engine parameter)
    template_id str
    Parameter template ID, automatically generated by the system
    template_source str
    Parameter template type. Values: System (system template), User (user template)
    update_time str
    Template modification time
    accountId String
    Account ID
    createTime String
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    id String
    The provider-assigned unique ID for this managed resource.
    needRestart Boolean
    Whether the template contains parameters that require a restart
    parameterNum Number
    Number of parameters included in the template
    templateCategory String
    Template category. Value: DBEngine (database engine parameter)
    templateId String
    Parameter template ID, automatically generated by the system
    templateSource String
    Parameter template type. Values: System (system template), User (user template)
    updateTime String
    Template modification time

    Look up Existing ParameterTemplate Resource

    Get an existing ParameterTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ParameterTemplateState, opts?: CustomResourceOptions): ParameterTemplate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account_id: Optional[str] = None,
        create_time: Optional[str] = None,
        engine_type: Optional[str] = None,
        need_restart: Optional[bool] = None,
        parameter_num: Optional[int] = None,
        project_name: Optional[str] = None,
        template_category: Optional[str] = None,
        template_desc: Optional[str] = None,
        template_id: Optional[str] = None,
        template_name: Optional[str] = None,
        template_params: Optional[Sequence[ParameterTemplateTemplateParamArgs]] = None,
        template_source: Optional[str] = None,
        template_type: Optional[str] = None,
        template_type_version: Optional[str] = None,
        update_time: Optional[str] = None) -> ParameterTemplate
    func GetParameterTemplate(ctx *Context, name string, id IDInput, state *ParameterTemplateState, opts ...ResourceOption) (*ParameterTemplate, error)
    public static ParameterTemplate Get(string name, Input<string> id, ParameterTemplateState? state, CustomResourceOptions? opts = null)
    public static ParameterTemplate get(String name, Output<String> id, ParameterTemplateState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:rdsmysql:ParameterTemplate    get:      id: ${id}
    import {
  to = volcenginecc_rdsmysql_parametertemplate.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Account ID
    CreateTime string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    EngineType string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    NeedRestart bool
    Whether the template contains parameters that require a restart
    ParameterNum int
    Number of parameters included in the template
    ProjectName string
    Associated project
    TemplateCategory string
    Template category. Value: DBEngine (database engine parameter)
    TemplateDesc string
    Parameter template description
    TemplateId string
    Parameter template ID, automatically generated by the system
    TemplateName string
    Parameter template name
    TemplateParams List<Volcengine.ParameterTemplateTemplateParam>
    TemplateSource string
    Parameter template type. Values: System (system template), User (user template)
    TemplateType string
    Database type of the parameter template. Default: Mysql
    TemplateTypeVersion string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    UpdateTime string
    Template modification time
    AccountId string
    Account ID
    CreateTime string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    EngineType string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    NeedRestart bool
    Whether the template contains parameters that require a restart
    ParameterNum int
    Number of parameters included in the template
    ProjectName string
    Associated project
    TemplateCategory string
    Template category. Value: DBEngine (database engine parameter)
    TemplateDesc string
    Parameter template description
    TemplateId string
    Parameter template ID, automatically generated by the system
    TemplateName string
    Parameter template name
    TemplateParams []ParameterTemplateTemplateParamArgs
    TemplateSource string
    Parameter template type. Values: System (system template), User (user template)
    TemplateType string
    Database type of the parameter template. Default: Mysql
    TemplateTypeVersion string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    UpdateTime string
    Template modification time
    account_id string
    Account ID
    create_time string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    engine_type string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    need_restart bool
    Whether the template contains parameters that require a restart
    parameter_num number
    Number of parameters included in the template
    project_name string
    Associated project
    template_category string
    Template category. Value: DBEngine (database engine parameter)
    template_desc string
    Parameter template description
    template_id string
    Parameter template ID, automatically generated by the system
    template_name string
    Parameter template name
    template_params list(object)
    template_source string
    Parameter template type. Values: System (system template), User (user template)
    template_type string
    Database type of the parameter template. Default: Mysql
    template_type_version string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    update_time string
    Template modification time
    accountId String
    Account ID
    createTime String
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    engineType String
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    needRestart Boolean
    Whether the template contains parameters that require a restart
    parameterNum Integer
    Number of parameters included in the template
    projectName String
    Associated project
    templateCategory String
    Template category. Value: DBEngine (database engine parameter)
    templateDesc String
    Parameter template description
    templateId String
    Parameter template ID, automatically generated by the system
    templateName String
    Parameter template name
    templateParams List<ParameterTemplateTemplateParam>
    templateSource String
    Parameter template type. Values: System (system template), User (user template)
    templateType String
    Database type of the parameter template. Default: Mysql
    templateTypeVersion String
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    updateTime String
    Template modification time
    accountId string
    Account ID
    createTime string
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    engineType string
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    needRestart boolean
    Whether the template contains parameters that require a restart
    parameterNum number
    Number of parameters included in the template
    projectName string
    Associated project
    templateCategory string
    Template category. Value: DBEngine (database engine parameter)
    templateDesc string
    Parameter template description
    templateId string
    Parameter template ID, automatically generated by the system
    templateName string
    Parameter template name
    templateParams ParameterTemplateTemplateParam[]
    templateSource string
    Parameter template type. Values: System (system template), User (user template)
    templateType string
    Database type of the parameter template. Default: Mysql
    templateTypeVersion string
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    updateTime string
    Template modification time
    account_id str
    Account ID
    create_time str
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    engine_type str
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    need_restart bool
    Whether the template contains parameters that require a restart
    parameter_num int
    Number of parameters included in the template
    project_name str
    Associated project
    template_category str
    Template category. Value: DBEngine (database engine parameter)
    template_desc str
    Parameter template description
    template_id str
    Parameter template ID, automatically generated by the system
    template_name str
    Parameter template name
    template_params Sequence[ParameterTemplateTemplateParamArgs]
    template_source str
    Parameter template type. Values: System (system template), User (user template)
    template_type str
    Database type of the parameter template. Default: Mysql
    template_type_version str
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    update_time str
    Template modification time
    accountId String
    Account ID
    createTime String
    Creation time (UTC+8), format: yyyy-MM-dd HH:mm:ss
    engineType String
    Database engine type. Values: InnoDB (InnoDB engine), RocksDB (RocksDB engine). Default: InnoDB
    needRestart Boolean
    Whether the template contains parameters that require a restart
    parameterNum Number
    Number of parameters included in the template
    projectName String
    Associated project
    templateCategory String
    Template category. Value: DBEngine (database engine parameter)
    templateDesc String
    Parameter template description
    templateId String
    Parameter template ID, automatically generated by the system
    templateName String
    Parameter template name
    templateParams List<Property Map>
    templateSource String
    Parameter template type. Values: System (system template), User (user template)
    templateType String
    Database type of the parameter template. Default: Mysql
    templateTypeVersion String
    Database version of the parameter template. Value range: MySQL57 (MySQL 5.7 version), MySQL80 (MySQL 8.0 version)
    updateTime String
    Template modification time

    Supporting Types

    ParameterTemplateTemplateParam, ParameterTemplateTemplateParamArgs

    Name string
    Instance parameter name
    RunningValue string
    Parameter runtime value
    Name string
    Instance parameter name
    RunningValue string
    Parameter runtime value
    name string
    Instance parameter name
    running_value string
    Parameter runtime value
    name String
    Instance parameter name
    runningValue String
    Parameter runtime value
    name string
    Instance parameter name
    runningValue string
    Parameter runtime value
    name str
    Instance parameter name
    running_value str
    Parameter runtime value
    name String
    Instance parameter name
    runningValue String
    Parameter runtime value

    Import

    $ pulumi import volcenginecc:rdsmysql/parameterTemplate:ParameterTemplate example "template_id"

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.35
    published on Thursday, May 14, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.