1. Packages
  2. Volcengine
  3. API Docs
  4. rds
  5. ParameterTemplate
Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine

volcengine.rds.ParameterTemplate

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.25 published on Tuesday, Jul 2, 2024 by Volcengine

    (Deprecated! Recommend use volcengine_rds_mysql_*** replace) Provides a resource to manage rds parameter template

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcengine = Pulumi.Volcengine;
    
    return await Deployment.RunAsync(() => 
    {
        var foo = new Volcengine.Rds.ParameterTemplate("foo", new()
        {
            TemplateDesc = "created by terraform",
            TemplateName = "tf-template",
            TemplateParams = new[]
            {
                new Volcengine.Rds.Inputs.ParameterTemplateTemplateParamArgs
                {
                    Name = "auto_increment_increment",
                    RunningValue = "2",
                },
                new Volcengine.Rds.Inputs.ParameterTemplateTemplateParamArgs
                {
                    Name = "slow_query_log",
                    RunningValue = "ON",
                },
                new Volcengine.Rds.Inputs.ParameterTemplateTemplateParamArgs
                {
                    Name = "net_retry_count",
                    RunningValue = "33",
                },
            },
            TemplateType = "MySQL",
            TemplateTypeVersion = "MySQL_Community_5_7",
        });
    
    });
    
    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.NewParameterTemplate(ctx, "foo", &rds.ParameterTemplateArgs{
    			TemplateDesc: pulumi.String("created by terraform"),
    			TemplateName: pulumi.String("tf-template"),
    			TemplateParams: rds.ParameterTemplateTemplateParamArray{
    				&rds.ParameterTemplateTemplateParamArgs{
    					Name:         pulumi.String("auto_increment_increment"),
    					RunningValue: pulumi.String("2"),
    				},
    				&rds.ParameterTemplateTemplateParamArgs{
    					Name:         pulumi.String("slow_query_log"),
    					RunningValue: pulumi.String("ON"),
    				},
    				&rds.ParameterTemplateTemplateParamArgs{
    					Name:         pulumi.String("net_retry_count"),
    					RunningValue: pulumi.String("33"),
    				},
    			},
    			TemplateType:        pulumi.String("MySQL"),
    			TemplateTypeVersion: pulumi.String("MySQL_Community_5_7"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcengine.rds.ParameterTemplate;
    import com.pulumi.volcengine.rds.ParameterTemplateArgs;
    import com.pulumi.volcengine.rds.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("created by terraform")
                .templateName("tf-template")
                .templateParams(            
                    ParameterTemplateTemplateParamArgs.builder()
                        .name("auto_increment_increment")
                        .runningValue("2")
                        .build(),
                    ParameterTemplateTemplateParamArgs.builder()
                        .name("slow_query_log")
                        .runningValue("ON")
                        .build(),
                    ParameterTemplateTemplateParamArgs.builder()
                        .name("net_retry_count")
                        .runningValue("33")
                        .build())
                .templateType("MySQL")
                .templateTypeVersion("MySQL_Community_5_7")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_volcengine as volcengine
    
    foo = volcengine.rds.ParameterTemplate("foo",
        template_desc="created by terraform",
        template_name="tf-template",
        template_params=[
            volcengine.rds.ParameterTemplateTemplateParamArgs(
                name="auto_increment_increment",
                running_value="2",
            ),
            volcengine.rds.ParameterTemplateTemplateParamArgs(
                name="slow_query_log",
                running_value="ON",
            ),
            volcengine.rds.ParameterTemplateTemplateParamArgs(
                name="net_retry_count",
                running_value="33",
            ),
        ],
        template_type="MySQL",
        template_type_version="MySQL_Community_5_7")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as volcengine from "@volcengine/pulumi";
    
    const foo = new volcengine.rds.ParameterTemplate("foo", {
        templateDesc: "created by terraform",
        templateName: "tf-template",
        templateParams: [
            {
                name: "auto_increment_increment",
                runningValue: "2",
            },
            {
                name: "slow_query_log",
                runningValue: "ON",
            },
            {
                name: "net_retry_count",
                runningValue: "33",
            },
        ],
        templateType: "MySQL",
        templateTypeVersion: "MySQL_Community_5_7",
    });
    
    resources:
      foo:
        type: volcengine:rds:ParameterTemplate
        properties:
          templateDesc: created by terraform
          templateName: tf-template
          templateParams:
            - name: auto_increment_increment
              runningValue: '2'
            - name: slow_query_log
              runningValue: ON
            - name: net_retry_count
              runningValue: '33'
          templateType: MySQL
          templateTypeVersion: MySQL_Community_5_7
    

    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_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: volcengine:rds: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 parameterTemplateResource = new Volcengine.Rds.ParameterTemplate("parameterTemplateResource", new()
    {
        TemplateName = "string",
        TemplateParams = new[]
        {
            new Volcengine.Rds.Inputs.ParameterTemplateTemplateParamArgs
            {
                Name = "string",
                RunningValue = "string",
            },
        },
        TemplateDesc = "string",
        TemplateType = "string",
        TemplateTypeVersion = "string",
    });
    
    example, err := rds.NewParameterTemplate(ctx, "parameterTemplateResource", &rds.ParameterTemplateArgs{
    	TemplateName: pulumi.String("string"),
    	TemplateParams: rds.ParameterTemplateTemplateParamArray{
    		&rds.ParameterTemplateTemplateParamArgs{
    			Name:         pulumi.String("string"),
    			RunningValue: pulumi.String("string"),
    		},
    	},
    	TemplateDesc:        pulumi.String("string"),
    	TemplateType:        pulumi.String("string"),
    	TemplateTypeVersion: pulumi.String("string"),
    })
    
    var parameterTemplateResource = new ParameterTemplate("parameterTemplateResource", ParameterTemplateArgs.builder()
        .templateName("string")
        .templateParams(ParameterTemplateTemplateParamArgs.builder()
            .name("string")
            .runningValue("string")
            .build())
        .templateDesc("string")
        .templateType("string")
        .templateTypeVersion("string")
        .build());
    
    parameter_template_resource = volcengine.rds.ParameterTemplate("parameterTemplateResource",
        template_name="string",
        template_params=[volcengine.rds.ParameterTemplateTemplateParamArgs(
            name="string",
            running_value="string",
        )],
        template_desc="string",
        template_type="string",
        template_type_version="string")
    
    const parameterTemplateResource = new volcengine.rds.ParameterTemplate("parameterTemplateResource", {
        templateName: "string",
        templateParams: [{
            name: "string",
            runningValue: "string",
        }],
        templateDesc: "string",
        templateType: "string",
        templateTypeVersion: "string",
    });
    
    type: volcengine:rds: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

    The ParameterTemplate resource accepts the following input properties:

    TemplateName string
    Parameter template name.
    TemplateParams List<ParameterTemplateTemplateParam>
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    TemplateDesc string
    Parameter template description.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    TemplateName string
    Parameter template name.
    TemplateParams []ParameterTemplateTemplateParamArgs
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    TemplateDesc string
    Parameter template description.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    templateName String
    Parameter template name.
    templateParams List<ParameterTemplateTemplateParam>
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    templateDesc String
    Parameter template description.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    templateName string
    Parameter template name.
    templateParams ParameterTemplateTemplateParam[]
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    templateDesc string
    Parameter template description.
    templateType string
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    templateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    template_name str
    Parameter template name.
    template_params Sequence[ParameterTemplateTemplateParamArgs]
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    template_desc str
    Parameter template description.
    template_type str
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    template_type_version str
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    templateName String
    Parameter template name.
    templateParams List<Property Map>
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    templateDesc String
    Parameter template description.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.

    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)
    Resource lookup is not supported in YAML
    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>
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    TemplateDesc string
    Parameter template description.
    TemplateName string
    Parameter template name.
    TemplateParams []ParameterTemplateTemplateParamArgs
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    TemplateType string
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    TemplateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    templateDesc String
    Parameter template description.
    templateName String
    Parameter template name.
    templateParams List<ParameterTemplateTemplateParam>
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    templateDesc string
    Parameter template description.
    templateName string
    Parameter template name.
    templateParams ParameterTemplateTemplateParam[]
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    templateType string
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    templateTypeVersion string
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    template_desc str
    Parameter template description.
    template_name str
    Parameter template name.
    template_params Sequence[ParameterTemplateTemplateParamArgs]
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    template_type str
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    template_type_version str
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.
    templateDesc String
    Parameter template description.
    templateName String
    Parameter template name.
    templateParams List<Property Map>
    Template parameters. InstanceParam only needs to pass Name and RunningValue.
    templateType String
    Parameter template database type, range of values: MySQL - MySQL database. (Defaults).
    templateTypeVersion String
    Parameter template database version, value range: MySQL_Community_5_7 - MySQL 5.7 (default) MySQL_8_0 - MySQL 8.0.

    Supporting Types

    ParameterTemplateTemplateParam, ParameterTemplateTemplateParamArgs

    Name string
    Parameter name.
    RunningValue string
    Parameter running value.
    Name string
    Parameter name.
    RunningValue string
    Parameter running value.
    name String
    Parameter name.
    runningValue String
    Parameter running value.
    name string
    Parameter name.
    runningValue string
    Parameter running value.
    name str
    Parameter name.
    running_value str
    Parameter running value.
    name String
    Parameter name.
    runningValue String
    Parameter running value.

    Import

    RDS Instance can be imported using the id, e.g.

     $ pulumi import volcengine:rds/parameterTemplate:ParameterTemplate default mysql-sys-80bb93aa14be22d0
    

    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.25 published on Tuesday, Jul 2, 2024 by Volcengine