Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. rds_mysql
  5. ParameterTemplate
Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.rds_mysql.ParameterTemplate

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage rds mysql parameter template

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";

const foo = new volcengine.rds_mysql.ParameterTemplate("foo", {
    templateDesc: "test",
    templateName: "test",
    templateParams: [{
        name: "auto_increment_increment",
        runningValue: "1",
    }],
    templateType: "Mysql",
    templateTypeVersion: "MySQL_8_0",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds_mysql.ParameterTemplate("foo",
    template_desc="test",
    template_name="test",
    template_params=[volcengine.rds_mysql.ParameterTemplateTemplateParamArgs(
        name="auto_increment_increment",
        running_value="1",
    )],
    template_type="Mysql",
    template_type_version="MySQL_8_0")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/rds_mysql"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds_mysql.NewParameterTemplate(ctx, "foo", &rds_mysql.ParameterTemplateArgs{
			TemplateDesc: pulumi.String("test"),
			TemplateName: pulumi.String("test"),
			TemplateParams: rds_mysql.ParameterTemplateTemplateParamArray{
				&rds_mysql.ParameterTemplateTemplateParamArgs{
					Name:         pulumi.String("auto_increment_increment"),
					RunningValue: pulumi.String("1"),
				},
			},
			TemplateType:        pulumi.String("Mysql"),
			TemplateTypeVersion: pulumi.String("MySQL_8_0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;

return await Deployment.RunAsync(() => 
{
    var foo = new Volcengine.Rds_mysql.ParameterTemplate("foo", new()
    {
        TemplateDesc = "test",
        TemplateName = "test",
        TemplateParams = new[]
        {
            new Volcengine.Rds_mysql.Inputs.ParameterTemplateTemplateParamArgs
            {
                Name = "auto_increment_increment",
                RunningValue = "1",
            },
        },
        TemplateType = "Mysql",
        TemplateTypeVersion = "MySQL_8_0",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_mysql.ParameterTemplate;
import com.pulumi.volcengine.rds_mysql.ParameterTemplateArgs;
import com.pulumi.volcengine.rds_mysql.inputs.ParameterTemplateTemplateParamArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new ParameterTemplate("foo", ParameterTemplateArgs.builder()        
            .templateDesc("test")
            .templateName("test")
            .templateParams(ParameterTemplateTemplateParamArgs.builder()
                .name("auto_increment_increment")
                .runningValue("1")
                .build())
            .templateType("Mysql")
            .templateTypeVersion("MySQL_8_0")
            .build());

    }
}

    resources:
  foo:
    type: volcengine:rds_mysql:ParameterTemplate
    properties:
      templateDesc: test
      templateName: test
      templateParams:
        - name: auto_increment_increment
          runningValue: '1'
      templateType: Mysql
      templateTypeVersion: MySQL_8_0

    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,
                      template_type: Optional[str] = None,
                      template_type_version: Optional[str] = None,
                      template_desc: 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: volcengine:rds_mysql:ParameterTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    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 volcengineParameterTemplateResource = new Volcengine.Rds_mysql.ParameterTemplate("volcengineParameterTemplateResource", new()
{
    TemplateName = "string",
    TemplateParams = new[]
    {
        new Volcengine.Rds_mysql.Inputs.ParameterTemplateTemplateParamArgs
        {
            Name = "string",
            RunningValue = "string",
        },
    },
    TemplateType = "string",
    TemplateTypeVersion = "string",
    TemplateDesc = "string",
});

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

    var volcengineParameterTemplateResource = new com.pulumi.volcengine.rds_mysql.ParameterTemplate("volcengineParameterTemplateResource", com.pulumi.volcengine.rds_mysql.ParameterTemplateArgs.builder()
    .templateName("string")
    .templateParams(ParameterTemplateTemplateParamArgs.builder()
        .name("string")
        .runningValue("string")
        .build())
    .templateType("string")
    .templateTypeVersion("string")
    .templateDesc("string")
    .build());

    volcengine_parameter_template_resource = volcengine.rds_mysql.ParameterTemplate("volcengineParameterTemplateResource",
    template_name="string",
    template_params=[{
        "name": "string",
        "running_value": "string",
    }],
    template_type="string",
    template_type_version="string",
    template_desc="string")

    const volcengineParameterTemplateResource = new volcengine.rds_mysql.ParameterTemplate("volcengineParameterTemplateResource", {
    templateName: "string",
    templateParams: [{
        name: "string",
        runningValue: "string",
    }],
    templateType: "string",
    templateTypeVersion: "string",
    templateDesc: "string",
});

    type: volcengine:rds_mysql:ParameterTemplate
properties:
    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<ParameterTemplateTemplateParam>
    Parameters contained in the parameter template.
    TemplateType string
    Database type of parameter template. The default value is Mysql.
    TemplateTypeVersion string
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    TemplateDesc string
    Parameter template description.
    TemplateName string
    Parameter template name.
    TemplateParams []ParameterTemplateTemplateParamArgs
    Parameters contained in the parameter template.
    TemplateType string
    Database type of parameter template. The default value is Mysql.
    TemplateTypeVersion string
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    TemplateDesc string
    Parameter template description.
    templateName String
    Parameter template name.
    templateParams List<ParameterTemplateTemplateParam>
    Parameters contained in the parameter template.
    templateType String
    Database type of parameter template. The default value is Mysql.
    templateTypeVersion String
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    templateDesc String
    Parameter template description.
    templateName string
    Parameter template name.
    templateParams ParameterTemplateTemplateParam[]
    Parameters contained in the parameter template.
    templateType string
    Database type of parameter template. The default value is Mysql.
    templateTypeVersion string
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    templateDesc string
    Parameter template description.
    template_name str
    Parameter template name.
    template_params Sequence[ParameterTemplateTemplateParamArgs]
    Parameters contained in the parameter template.
    template_type str
    Database type of parameter template. The default value is Mysql.
    template_type_version str
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    template_desc str
    Parameter template description.
    templateName String
    Parameter template name.
    templateParams List<Property Map>
    Parameters contained in the parameter template.
    templateType String
    Database type of parameter template. The default value is Mysql.
    templateTypeVersion String
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    templateDesc String
    Parameter template description.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    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,
        template_desc: Optional[str] = None,
        template_name: Optional[str] = None,
        template_params: Optional[Sequence[ParameterTemplateTemplateParamArgs]] = None,
        template_type: Optional[str] = None,
        template_type_version: 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: volcengine:rds_mysql:ParameterTemplate    get:      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:
    TemplateDesc string
    Parameter template description.
    TemplateName string
    Parameter template name.
    TemplateParams List<ParameterTemplateTemplateParam>
    Parameters contained in the parameter template.
    TemplateType string
    Database type of parameter template. The default value is Mysql.
    TemplateTypeVersion string
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    TemplateDesc string
    Parameter template description.
    TemplateName string
    Parameter template name.
    TemplateParams []ParameterTemplateTemplateParamArgs
    Parameters contained in the parameter template.
    TemplateType string
    Database type of parameter template. The default value is Mysql.
    TemplateTypeVersion string
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    templateDesc String
    Parameter template description.
    templateName String
    Parameter template name.
    templateParams List<ParameterTemplateTemplateParam>
    Parameters contained in the parameter template.
    templateType String
    Database type of parameter template. The default value is Mysql.
    templateTypeVersion String
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    templateDesc string
    Parameter template description.
    templateName string
    Parameter template name.
    templateParams ParameterTemplateTemplateParam[]
    Parameters contained in the parameter template.
    templateType string
    Database type of parameter template. The default value is Mysql.
    templateTypeVersion string
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    template_desc str
    Parameter template description.
    template_name str
    Parameter template name.
    template_params Sequence[ParameterTemplateTemplateParamArgs]
    Parameters contained in the parameter template.
    template_type str
    Database type of parameter template. The default value is Mysql.
    template_type_version str
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.
    templateDesc String
    Parameter template description.
    templateName String
    Parameter template name.
    templateParams List<Property Map>
    Parameters contained in the parameter template.
    templateType String
    Database type of parameter template. The default value is Mysql.
    templateTypeVersion String
    Database version of parameter template. Value range: MySQL_5_7: Default value. MySQL 5.7 version. MySQL_8_0: MySQL 8.0 version.

    Supporting Types

    ParameterTemplateTemplateParam, ParameterTemplateTemplateParamArgs

    Name string
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    RunningValue string
    Parameter running value. Description: When making request parameters in CreateParameterTemplate and ModifyParameterTemplate, only Name and RunningValue need to be passed in.
    Name string
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    RunningValue string
    Parameter running value. Description: When making request parameters in CreateParameterTemplate and ModifyParameterTemplate, only Name and RunningValue need to be passed in.
    name String
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    runningValue String
    Parameter running value. Description: When making request parameters in CreateParameterTemplate and ModifyParameterTemplate, only Name and RunningValue need to be passed in.
    name string
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    runningValue string
    Parameter running value. Description: When making request parameters in CreateParameterTemplate and ModifyParameterTemplate, only Name and RunningValue need to be passed in.
    name str
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    running_value str
    Parameter running value. Description: When making request parameters in CreateParameterTemplate and ModifyParameterTemplate, only Name and RunningValue need to be passed in.
    name String
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    runningValue String
    Parameter running value. Description: When making request parameters in CreateParameterTemplate and ModifyParameterTemplate, only Name and RunningValue need to be passed in.

    Import

    RdsMysqlParameterTemplate can be imported using the id, e.g.

    $ pulumi import volcengine:rds_mysql/parameterTemplate:ParameterTemplate default resource_id

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

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.29 published on Tuesday, Apr 29, 2025 by Volcengine
    volcengine/pulumi-volcengine