Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. rds
  5. getParameterTemplates
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.rds.getParameterTemplates

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.31 published on Monday, May 12, 2025 by Volcengine
volcengine/pulumi-volcengine

    (Deprecated! Recommend use volcengine_rds_mysql_*** replace) Use this data source to query detailed information of rds parameter templates

    Example Usage

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

const default = volcengine.rds.getParameterTemplates({});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.rds.get_parameter_templates()

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rds.GetParameterTemplates(ctx, nil, 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 @default = Volcengine.Rds.GetParameterTemplates.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.rds.RdsFunctions;
import com.pulumi.volcengine.rds.inputs.GetParameterTemplatesArgs;
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 default = RdsFunctions.getParameterTemplates();

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:rds:getParameterTemplates
      Arguments: {}

    Using getParameterTemplates

    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 getParameterTemplates(args: GetParameterTemplatesArgs, opts?: InvokeOptions): Promise<GetParameterTemplatesResult>
function getParameterTemplatesOutput(args: GetParameterTemplatesOutputArgs, opts?: InvokeOptions): Output<GetParameterTemplatesResult>
    def get_parameter_templates(name_regex: Optional[str] = None,
                            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) -> GetParameterTemplatesResult
def get_parameter_templates_output(name_regex: Optional[pulumi.Input[str]] = None,
                            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[GetParameterTemplatesResult]
    func GetParameterTemplates(ctx *Context, args *GetParameterTemplatesArgs, opts ...InvokeOption) (*GetParameterTemplatesResult, error)
func GetParameterTemplatesOutput(ctx *Context, args *GetParameterTemplatesOutputArgs, opts ...InvokeOption) GetParameterTemplatesResultOutput

    > Note: This function is named GetParameterTemplates in the Go SDK.

    public static class GetParameterTemplates 
{
    public static Task<GetParameterTemplatesResult> InvokeAsync(GetParameterTemplatesArgs args, InvokeOptions? opts = null)
    public static Output<GetParameterTemplatesResult> Invoke(GetParameterTemplatesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetParameterTemplatesResult> getParameterTemplates(GetParameterTemplatesArgs args, InvokeOptions options)
public static Output<GetParameterTemplatesResult> getParameterTemplates(GetParameterTemplatesArgs args, InvokeOptions options)

    fn::invoke:
  function: volcengine:rds/getParameterTemplates:getParameterTemplates
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NameRegex string
    A Name Regex of RDS parameter template.
    OutputFile string
    File name where to save data source results.
    TemplateCategory string
    Parameter template type, range of values: DBEngine - Engine parameters.
    TemplateSource string
    Template source, value range: System - System User - the user.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    NameRegex string
    A Name Regex of RDS parameter template.
    OutputFile string
    File name where to save data source results.
    TemplateCategory string
    Parameter template type, range of values: DBEngine - Engine parameters.
    TemplateSource string
    Template source, value range: System - System User - the user.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    nameRegex String
    A Name Regex of RDS parameter template.
    outputFile String
    File name where to save data source results.
    templateCategory String
    Parameter template type, range of values: DBEngine - Engine parameters.
    templateSource String
    Template source, value range: System - System User - the user.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    nameRegex string
    A Name Regex of RDS parameter template.
    outputFile string
    File name where to save data source results.
    templateCategory string
    Parameter template type, range of values: DBEngine - Engine parameters.
    templateSource string
    Template source, value range: System - System User - the user.
    templateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    name_regex str
    A Name Regex of RDS parameter template.
    output_file str
    File name where to save data source results.
    template_category str
    Parameter template type, range of values: DBEngine - Engine parameters.
    template_source str
    Template source, value range: System - System User - the user.
    template_type str
    Parameter template database type, range of values: MySQL - MySQL database.
    template_type_version str
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    nameRegex String
    A Name Regex of RDS parameter template.
    outputFile String
    File name where to save data source results.
    templateCategory String
    Parameter template type, range of values: DBEngine - Engine parameters.
    templateSource String
    Template source, value range: System - System User - the user.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.

    getParameterTemplates Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    RdsParameterTemplates List<GetParameterTemplatesRdsParameterTemplate>
    The collection of RDS parameter templates query.
    TotalCount int
    The total count of RDS parameter templates query.
    NameRegex string
    OutputFile string
    TemplateCategory string
    TemplateSource string
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    Id string
    The provider-assigned unique ID for this managed resource.
    RdsParameterTemplates []GetParameterTemplatesRdsParameterTemplate
    The collection of RDS parameter templates query.
    TotalCount int
    The total count of RDS parameter templates query.
    NameRegex string
    OutputFile string
    TemplateCategory string
    TemplateSource string
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    id String
    The provider-assigned unique ID for this managed resource.
    rdsParameterTemplates List<GetParameterTemplatesRdsParameterTemplate>
    The collection of RDS parameter templates query.
    totalCount Integer
    The total count of RDS parameter templates query.
    nameRegex String
    outputFile String
    templateCategory String
    templateSource String
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    id string
    The provider-assigned unique ID for this managed resource.
    rdsParameterTemplates GetParameterTemplatesRdsParameterTemplate[]
    The collection of RDS parameter templates query.
    totalCount number
    The total count of RDS parameter templates query.
    nameRegex string
    outputFile string
    templateCategory string
    templateSource string
    templateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    id str
    The provider-assigned unique ID for this managed resource.
    rds_parameter_templates Sequence[GetParameterTemplatesRdsParameterTemplate]
    The collection of RDS parameter templates query.
    total_count int
    The total count of RDS parameter templates query.
    name_regex str
    output_file str
    template_category str
    template_source str
    template_type str
    Parameter template database type, range of values: MySQL - MySQL database.
    template_type_version str
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    id String
    The provider-assigned unique ID for this managed resource.
    rdsParameterTemplates List<Property Map>
    The collection of RDS parameter templates query.
    totalCount Number
    The total count of RDS parameter templates query.
    nameRegex String
    outputFile String
    templateCategory String
    templateSource String
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.

    Supporting Types

    GetParameterTemplatesRdsParameterTemplate

    CreateTime string
    Creation time.
    Id string
    The ID of the RDS parameter template.
    NeedRestart bool
    Whether the template contains parameters that need to be restarted.
    ParameterNum int
    The number of parameters the template contains.
    TemplateDesc string
    The description of the RDS parameter template.
    TemplateId string
    The ID of the RDS parameter template.
    TemplateName string
    The name of the RDS parameter template.
    TemplateParams List<GetParameterTemplatesRdsParameterTemplateTemplateParam>
    Parameters contained in the template.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    UpdateTime string
    Update time.
    CreateTime string
    Creation time.
    Id string
    The ID of the RDS parameter template.
    NeedRestart bool
    Whether the template contains parameters that need to be restarted.
    ParameterNum int
    The number of parameters the template contains.
    TemplateDesc string
    The description of the RDS parameter template.
    TemplateId string
    The ID of the RDS parameter template.
    TemplateName string
    The name of the RDS parameter template.
    TemplateParams []GetParameterTemplatesRdsParameterTemplateTemplateParam
    Parameters contained in the template.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    UpdateTime string
    Update time.
    createTime String
    Creation time.
    id String
    The ID of the RDS parameter template.
    needRestart Boolean
    Whether the template contains parameters that need to be restarted.
    parameterNum Integer
    The number of parameters the template contains.
    templateDesc String
    The description of the RDS parameter template.
    templateId String
    The ID of the RDS parameter template.
    templateName String
    The name of the RDS parameter template.
    templateParams List<GetParameterTemplatesRdsParameterTemplateTemplateParam>
    Parameters contained in the template.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    updateTime String
    Update time.
    createTime string
    Creation time.
    id string
    The ID of the RDS parameter template.
    needRestart boolean
    Whether the template contains parameters that need to be restarted.
    parameterNum number
    The number of parameters the template contains.
    templateDesc string
    The description of the RDS parameter template.
    templateId string
    The ID of the RDS parameter template.
    templateName string
    The name of the RDS parameter template.
    templateParams GetParameterTemplatesRdsParameterTemplateTemplateParam[]
    Parameters contained in the template.
    templateType string
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    updateTime string
    Update time.
    create_time str
    Creation time.
    id str
    The ID of the RDS parameter template.
    need_restart bool
    Whether the template contains parameters that need to be restarted.
    parameter_num int
    The number of parameters the template contains.
    template_desc str
    The description of the RDS parameter template.
    template_id str
    The ID of the RDS parameter template.
    template_name str
    The name of the RDS parameter template.
    template_params Sequence[GetParameterTemplatesRdsParameterTemplateTemplateParam]
    Parameters contained in the template.
    template_type str
    Parameter template database type, range of values: MySQL - MySQL database.
    template_type_version str
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    update_time str
    Update time.
    createTime String
    Creation time.
    id String
    The ID of the RDS parameter template.
    needRestart Boolean
    Whether the template contains parameters that need to be restarted.
    parameterNum Number
    The number of parameters the template contains.
    templateDesc String
    The description of the RDS parameter template.
    templateId String
    The ID of the RDS parameter template.
    templateName String
    The name of the RDS parameter template.
    templateParams List<Property Map>
    Parameters contained in the template.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database.
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 MySQL_8_0 - MySQL 8.0.
    updateTime String
    Update time.

    GetParameterTemplatesRdsParameterTemplateTemplateParam

    DefaultValue string
    Parameter default value.
    Description string
    Parameter description.
    Name string
    Parameter name.
    Restart bool
    Whether the modified parameters need to be restarted to take effect.
    RunningValue string
    Parameter running value.
    ValueRange string
    Parameter value range.
    DefaultValue string
    Parameter default value.
    Description string
    Parameter description.
    Name string
    Parameter name.
    Restart bool
    Whether the modified parameters need to be restarted to take effect.
    RunningValue string
    Parameter running value.
    ValueRange string
    Parameter value range.
    defaultValue String
    Parameter default value.
    description String
    Parameter description.
    name String
    Parameter name.
    restart Boolean
    Whether the modified parameters need to be restarted to take effect.
    runningValue String
    Parameter running value.
    valueRange String
    Parameter value range.
    defaultValue string
    Parameter default value.
    description string
    Parameter description.
    name string
    Parameter name.
    restart boolean
    Whether the modified parameters need to be restarted to take effect.
    runningValue string
    Parameter running value.
    valueRange string
    Parameter value range.
    default_value str
    Parameter default value.
    description str
    Parameter description.
    name str
    Parameter name.
    restart bool
    Whether the modified parameters need to be restarted to take effect.
    running_value str
    Parameter running value.
    value_range str
    Parameter value range.
    defaultValue String
    Parameter default value.
    description String
    Parameter description.
    name String
    Parameter name.
    restart Boolean
    Whether the modified parameters need to be restarted to take effect.
    runningValue String
    Parameter running value.
    valueRange String
    Parameter value range.

    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.31 published on Monday, May 12, 2025 by Volcengine
    volcengine/pulumi-volcengine