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

volcengine.rds_mysql.ParameterTemplates

Explore with Pulumi AI

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

    Use this data source to query detailed information of rds mysql parameter templates

    Example Usage

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

const foo = volcengine.rds_mysql.ParameterTemplates({
    templateCategory: "DBEngine",
    templateSource: "User",
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.rds_mysql.parameter_templates(template_category="DBEngine",
    template_source="User")

    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.ParameterTemplates(ctx, &rds_mysql.ParameterTemplatesArgs{
			TemplateCategory: pulumi.StringRef("DBEngine"),
			TemplateSource:   pulumi.StringRef("User"),
		}, nil)
		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 = Volcengine.Rds_mysql.ParameterTemplates.Invoke(new()
    {
        TemplateCategory = "DBEngine",
        TemplateSource = "User",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds_mysql.Rds_mysqlFunctions;
import com.pulumi.volcengine.rds_mysql.inputs.ParameterTemplatesArgs;
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) {
        final var foo = Rds_mysqlFunctions.ParameterTemplates(ParameterTemplatesArgs.builder()
            .templateCategory("DBEngine")
            .templateSource("User")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      Function: volcengine:rds_mysql:ParameterTemplates
      Arguments:
        templateCategory: DBEngine
        templateSource: User

    Using ParameterTemplates

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function parameterTemplates(args: ParameterTemplatesArgs, opts?: InvokeOptions): Promise<ParameterTemplatesResult>
function parameterTemplatesOutput(args: ParameterTemplatesOutputArgs, opts?: InvokeOptions): Output<ParameterTemplatesResult>
    def parameter_templates(output_file: Optional[str] = None,
                        template_category: Optional[str] = None,
                        template_source: Optional[str] = None,
                        template_type: Optional[str] = None,
                        template_type_version: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> ParameterTemplatesResult
def parameter_templates_output(output_file: Optional[pulumi.Input[str]] = None,
                        template_category: Optional[pulumi.Input[str]] = None,
                        template_source: Optional[pulumi.Input[str]] = None,
                        template_type: Optional[pulumi.Input[str]] = None,
                        template_type_version: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[ParameterTemplatesResult]
    func ParameterTemplates(ctx *Context, args *ParameterTemplatesArgs, opts ...InvokeOption) (*ParameterTemplatesResult, error)
func ParameterTemplatesOutput(ctx *Context, args *ParameterTemplatesOutputArgs, opts ...InvokeOption) ParameterTemplatesResultOutput
    public static class ParameterTemplates 
{
    public static Task<ParameterTemplatesResult> InvokeAsync(ParameterTemplatesArgs args, InvokeOptions? opts = null)
    public static Output<ParameterTemplatesResult> Invoke(ParameterTemplatesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<ParameterTemplatesResult> parameterTemplates(ParameterTemplatesArgs args, InvokeOptions options)
public static Output<ParameterTemplatesResult> parameterTemplates(ParameterTemplatesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rds_mysql:ParameterTemplates
  arguments:
    # arguments dictionary

    The following arguments are supported:

    OutputFile string
    File name where to save data source results.
    TemplateCategory string
    Template category, with a value of DBEngine (database engine parameters).
    TemplateSource string
    Parameter template source, value range: System. User.
    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.
    OutputFile string
    File name where to save data source results.
    TemplateCategory string
    Template category, with a value of DBEngine (database engine parameters).
    TemplateSource string
    Parameter template source, value range: System. User.
    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.
    outputFile String
    File name where to save data source results.
    templateCategory String
    Template category, with a value of DBEngine (database engine parameters).
    templateSource String
    Parameter template source, value range: System. User.
    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.
    outputFile string
    File name where to save data source results.
    templateCategory string
    Template category, with a value of DBEngine (database engine parameters).
    templateSource string
    Parameter template source, value range: System. User.
    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.
    output_file str
    File name where to save data source results.
    template_category str
    Template category, with a value of DBEngine (database engine parameters).
    template_source str
    Parameter template source, value range: System. User.
    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.
    outputFile String
    File name where to save data source results.
    templateCategory String
    Template category, with a value of DBEngine (database engine parameters).
    templateSource String
    Parameter template source, value range: System. User.
    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.

    ParameterTemplates Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Templates List<ParameterTemplatesTemplate>
    The collection of query.
    TotalCount int
    The total count of query.
    OutputFile string
    TemplateCategory string
    Template category, with a value of DBEngine (database engine parameter).
    TemplateSource string
    The type of parameter template. Values: System: System template. User: User template.
    TemplateType string
    The database type of the parameter template. The default value is Mysql.
    TemplateTypeVersion string
    Parameter template database version, value range: "MySQL_5_7": MySQL 5.7 version. "MySQL_8_0": MySQL 8.0 version.
    Id string
    The provider-assigned unique ID for this managed resource.
    Templates []ParameterTemplatesTemplate
    The collection of query.
    TotalCount int
    The total count of query.
    OutputFile string
    TemplateCategory string
    Template category, with a value of DBEngine (database engine parameter).
    TemplateSource string
    The type of parameter template. Values: System: System template. User: User template.
    TemplateType string
    The database type of the parameter template. The default value is Mysql.
    TemplateTypeVersion string
    Parameter template database version, value range: "MySQL_5_7": MySQL 5.7 version. "MySQL_8_0": MySQL 8.0 version.
    id String
    The provider-assigned unique ID for this managed resource.
    templates List<ParameterTemplatesTemplate>
    The collection of query.
    totalCount Integer
    The total count of query.
    outputFile String
    templateCategory String
    Template category, with a value of DBEngine (database engine parameter).
    templateSource String
    The type of parameter template. Values: System: System template. User: User template.
    templateType String
    The database type of the parameter template. The default value is Mysql.
    templateTypeVersion String
    Parameter template database version, value range: "MySQL_5_7": MySQL 5.7 version. "MySQL_8_0": MySQL 8.0 version.
    id string
    The provider-assigned unique ID for this managed resource.
    templates ParameterTemplatesTemplate[]
    The collection of query.
    totalCount number
    The total count of query.
    outputFile string
    templateCategory string
    Template category, with a value of DBEngine (database engine parameter).
    templateSource string
    The type of parameter template. Values: System: System template. User: User template.
    templateType string
    The database type of the parameter template. The default value is Mysql.
    templateTypeVersion string
    Parameter template database version, value range: "MySQL_5_7": MySQL 5.7 version. "MySQL_8_0": MySQL 8.0 version.
    id str
    The provider-assigned unique ID for this managed resource.
    templates Sequence[ParameterTemplatesTemplate]
    The collection of query.
    total_count int
    The total count of query.
    output_file str
    template_category str
    Template category, with a value of DBEngine (database engine parameter).
    template_source str
    The type of parameter template. Values: System: System template. User: User template.
    template_type str
    The database type of the parameter template. The default value is Mysql.
    template_type_version str
    Parameter template database version, value range: "MySQL_5_7": MySQL 5.7 version. "MySQL_8_0": MySQL 8.0 version.
    id String
    The provider-assigned unique ID for this managed resource.
    templates List<Property Map>
    The collection of query.
    totalCount Number
    The total count of query.
    outputFile String
    templateCategory String
    Template category, with a value of DBEngine (database engine parameter).
    templateSource String
    The type of parameter template. Values: System: System template. User: User template.
    templateType String
    The database type of the parameter template. The default value is Mysql.
    templateTypeVersion String
    Parameter template database version, value range: "MySQL_5_7": MySQL 5.7 version. "MySQL_8_0": MySQL 8.0 version.

    Supporting Types

    ParameterTemplatesTemplate

    AccountId string
    The account ID.
    CreateTime string
    Creation time.
    NeedRestart bool
    Does the template contain parameters that require restart.
    ParameterNum int
    The number of parameters contained in the template.
    ProjectName string
    The project to which the template belongs.
    TemplateCategory string
    Template category, with a value of DBEngine (database engine parameters).
    TemplateDesc string
    Parameter template description.
    TemplateId string
    Parameter template ID.
    TemplateName string
    Parameter template name.
    TemplateParams List<ParameterTemplatesTemplateTemplateParam>
    Parameters contained in the template.
    TemplateSource string
    Parameter template source, value range: System. User.
    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.
    UpdateTime string
    Modification time of the template.
    AccountId string
    The account ID.
    CreateTime string
    Creation time.
    NeedRestart bool
    Does the template contain parameters that require restart.
    ParameterNum int
    The number of parameters contained in the template.
    ProjectName string
    The project to which the template belongs.
    TemplateCategory string
    Template category, with a value of DBEngine (database engine parameters).
    TemplateDesc string
    Parameter template description.
    TemplateId string
    Parameter template ID.
    TemplateName string
    Parameter template name.
    TemplateParams []ParameterTemplatesTemplateTemplateParam
    Parameters contained in the template.
    TemplateSource string
    Parameter template source, value range: System. User.
    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.
    UpdateTime string
    Modification time of the template.
    accountId String
    The account ID.
    createTime String
    Creation time.
    needRestart Boolean
    Does the template contain parameters that require restart.
    parameterNum Integer
    The number of parameters contained in the template.
    projectName String
    The project to which the template belongs.
    templateCategory String
    Template category, with a value of DBEngine (database engine parameters).
    templateDesc String
    Parameter template description.
    templateId String
    Parameter template ID.
    templateName String
    Parameter template name.
    templateParams List<ParameterTemplatesTemplateTemplateParam>
    Parameters contained in the template.
    templateSource String
    Parameter template source, value range: System. User.
    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.
    updateTime String
    Modification time of the template.
    accountId string
    The account ID.
    createTime string
    Creation time.
    needRestart boolean
    Does the template contain parameters that require restart.
    parameterNum number
    The number of parameters contained in the template.
    projectName string
    The project to which the template belongs.
    templateCategory string
    Template category, with a value of DBEngine (database engine parameters).
    templateDesc string
    Parameter template description.
    templateId string
    Parameter template ID.
    templateName string
    Parameter template name.
    templateParams ParameterTemplatesTemplateTemplateParam[]
    Parameters contained in the template.
    templateSource string
    Parameter template source, value range: System. User.
    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.
    updateTime string
    Modification time of the template.
    account_id str
    The account ID.
    create_time str
    Creation time.
    need_restart bool
    Does the template contain parameters that require restart.
    parameter_num int
    The number of parameters contained in the template.
    project_name str
    The project to which the template belongs.
    template_category str
    Template category, with a value of DBEngine (database engine parameters).
    template_desc str
    Parameter template description.
    template_id str
    Parameter template ID.
    template_name str
    Parameter template name.
    template_params Sequence[ParameterTemplatesTemplateTemplateParam]
    Parameters contained in the template.
    template_source str
    Parameter template source, value range: System. User.
    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.
    update_time str
    Modification time of the template.
    accountId String
    The account ID.
    createTime String
    Creation time.
    needRestart Boolean
    Does the template contain parameters that require restart.
    parameterNum Number
    The number of parameters contained in the template.
    projectName String
    The project to which the template belongs.
    templateCategory String
    Template category, with a value of DBEngine (database engine parameters).
    templateDesc String
    Parameter template description.
    templateId String
    Parameter template ID.
    templateName String
    Parameter template name.
    templateParams List<Property Map>
    Parameters contained in the template.
    templateSource String
    Parameter template source, value range: System. User.
    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.
    updateTime String
    Modification time of the template.

    ParameterTemplatesTemplateTemplateParam

    DefaultValue string
    Parameter default value.
    Description string
    Parameter description.
    Name string
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    Restart bool
    Is it necessary to restart the instance for the changes to take effect.
    RunningValue string
    Parameter running value. Description: When making requests with CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    ValueRange string
    Value range of parameters.
    DefaultValue string
    Parameter default value.
    Description string
    Parameter description.
    Name string
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    Restart bool
    Is it necessary to restart the instance for the changes to take effect.
    RunningValue string
    Parameter running value. Description: When making requests with CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    ValueRange string
    Value range of parameters.
    defaultValue String
    Parameter default value.
    description String
    Parameter description.
    name String
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    restart Boolean
    Is it necessary to restart the instance for the changes to take effect.
    runningValue String
    Parameter running value. Description: When making requests with CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    valueRange String
    Value range of parameters.
    defaultValue string
    Parameter default value.
    description string
    Parameter description.
    name string
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    restart boolean
    Is it necessary to restart the instance for the changes to take effect.
    runningValue string
    Parameter running value. Description: When making requests with CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    valueRange string
    Value range of parameters.
    default_value str
    Parameter default value.
    description str
    Parameter description.
    name str
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    restart bool
    Is it necessary to restart the instance for the changes to take effect.
    running_value str
    Parameter running value. Description: When making requests with CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    value_range str
    Value range of parameters.
    defaultValue String
    Parameter default value.
    description String
    Parameter description.
    name String
    Instance parameter name. Description: When using CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    restart Boolean
    Is it necessary to restart the instance for the changes to take effect.
    runningValue String
    Parameter running value. Description: When making requests with CreateParameterTemplate and ModifyParameterTemplate as request parameters, only Name and RunningValue need to be passed in.
    valueRange String
    Value range of parameters.

    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