1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. rds
  5. RdsParameterGroup
Alibaba Cloud v3.69.0 published on Monday, Dec 9, 2024 by Pulumi

alicloud.rds.RdsParameterGroup

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.69.0 published on Monday, Dec 9, 2024 by Pulumi

    Provides a RDS Parameter Group resource.

    For information about RDS Parameter Group and how to use it, see What is Parameter Group.

    NOTE: Available since v1.119.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "tf_example";
    const _default = new alicloud.rds.RdsParameterGroup("default", {
        engine: "mysql",
        engineVersion: "5.7",
        paramDetails: [
            {
                paramName: "back_log",
                paramValue: "4000",
            },
            {
                paramName: "wait_timeout",
                paramValue: "86460",
            },
        ],
        parameterGroupDesc: name,
        parameterGroupName: name,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "tf_example"
    default = alicloud.rds.RdsParameterGroup("default",
        engine="mysql",
        engine_version="5.7",
        param_details=[
            {
                "param_name": "back_log",
                "param_value": "4000",
            },
            {
                "param_name": "wait_timeout",
                "param_value": "86460",
            },
        ],
        parameter_group_desc=name,
        parameter_group_name=name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/rds"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		name := "tf_example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		_, err := rds.NewRdsParameterGroup(ctx, "default", &rds.RdsParameterGroupArgs{
    			Engine:        pulumi.String("mysql"),
    			EngineVersion: pulumi.String("5.7"),
    			ParamDetails: rds.RdsParameterGroupParamDetailArray{
    				&rds.RdsParameterGroupParamDetailArgs{
    					ParamName:  pulumi.String("back_log"),
    					ParamValue: pulumi.String("4000"),
    				},
    				&rds.RdsParameterGroupParamDetailArgs{
    					ParamName:  pulumi.String("wait_timeout"),
    					ParamValue: pulumi.String("86460"),
    				},
    			},
    			ParameterGroupDesc: pulumi.String(name),
    			ParameterGroupName: pulumi.String(name),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "tf_example";
        var @default = new AliCloud.Rds.RdsParameterGroup("default", new()
        {
            Engine = "mysql",
            EngineVersion = "5.7",
            ParamDetails = new[]
            {
                new AliCloud.Rds.Inputs.RdsParameterGroupParamDetailArgs
                {
                    ParamName = "back_log",
                    ParamValue = "4000",
                },
                new AliCloud.Rds.Inputs.RdsParameterGroupParamDetailArgs
                {
                    ParamName = "wait_timeout",
                    ParamValue = "86460",
                },
            },
            ParameterGroupDesc = name,
            ParameterGroupName = name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.rds.RdsParameterGroup;
    import com.pulumi.alicloud.rds.RdsParameterGroupArgs;
    import com.pulumi.alicloud.rds.inputs.RdsParameterGroupParamDetailArgs;
    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 config = ctx.config();
            final var name = config.get("name").orElse("tf_example");
            var default_ = new RdsParameterGroup("default", RdsParameterGroupArgs.builder()
                .engine("mysql")
                .engineVersion("5.7")
                .paramDetails(            
                    RdsParameterGroupParamDetailArgs.builder()
                        .paramName("back_log")
                        .paramValue("4000")
                        .build(),
                    RdsParameterGroupParamDetailArgs.builder()
                        .paramName("wait_timeout")
                        .paramValue("86460")
                        .build())
                .parameterGroupDesc(name)
                .parameterGroupName(name)
                .build());
    
        }
    }
    
    configuration:
      name:
        type: string
        default: tf_example
    resources:
      default:
        type: alicloud:rds:RdsParameterGroup
        properties:
          engine: mysql
          engineVersion: '5.7'
          paramDetails:
            - paramName: back_log
              paramValue: '4000'
            - paramName: wait_timeout
              paramValue: '86460'
          parameterGroupDesc: ${name}
          parameterGroupName: ${name}
    

    Create RdsParameterGroup Resource

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

    Constructor syntax

    new RdsParameterGroup(name: string, args: RdsParameterGroupArgs, opts?: CustomResourceOptions);
    @overload
    def RdsParameterGroup(resource_name: str,
                          args: RdsParameterGroupArgs,
                          opts: Optional[ResourceOptions] = None)
    
    @overload
    def RdsParameterGroup(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          engine: Optional[str] = None,
                          engine_version: Optional[str] = None,
                          param_details: Optional[Sequence[RdsParameterGroupParamDetailArgs]] = None,
                          parameter_group_name: Optional[str] = None,
                          parameter_group_desc: Optional[str] = None)
    func NewRdsParameterGroup(ctx *Context, name string, args RdsParameterGroupArgs, opts ...ResourceOption) (*RdsParameterGroup, error)
    public RdsParameterGroup(string name, RdsParameterGroupArgs args, CustomResourceOptions? opts = null)
    public RdsParameterGroup(String name, RdsParameterGroupArgs args)
    public RdsParameterGroup(String name, RdsParameterGroupArgs args, CustomResourceOptions options)
    
    type: alicloud:rds:RdsParameterGroup
    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 RdsParameterGroupArgs
    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 RdsParameterGroupArgs
    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 RdsParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RdsParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RdsParameterGroupArgs
    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 rdsParameterGroupResource = new AliCloud.Rds.RdsParameterGroup("rdsParameterGroupResource", new()
    {
        Engine = "string",
        EngineVersion = "string",
        ParamDetails = new[]
        {
            new AliCloud.Rds.Inputs.RdsParameterGroupParamDetailArgs
            {
                ParamName = "string",
                ParamValue = "string",
            },
        },
        ParameterGroupName = "string",
        ParameterGroupDesc = "string",
    });
    
    example, err := rds.NewRdsParameterGroup(ctx, "rdsParameterGroupResource", &rds.RdsParameterGroupArgs{
    	Engine:        pulumi.String("string"),
    	EngineVersion: pulumi.String("string"),
    	ParamDetails: rds.RdsParameterGroupParamDetailArray{
    		&rds.RdsParameterGroupParamDetailArgs{
    			ParamName:  pulumi.String("string"),
    			ParamValue: pulumi.String("string"),
    		},
    	},
    	ParameterGroupName: pulumi.String("string"),
    	ParameterGroupDesc: pulumi.String("string"),
    })
    
    var rdsParameterGroupResource = new RdsParameterGroup("rdsParameterGroupResource", RdsParameterGroupArgs.builder()
        .engine("string")
        .engineVersion("string")
        .paramDetails(RdsParameterGroupParamDetailArgs.builder()
            .paramName("string")
            .paramValue("string")
            .build())
        .parameterGroupName("string")
        .parameterGroupDesc("string")
        .build());
    
    rds_parameter_group_resource = alicloud.rds.RdsParameterGroup("rdsParameterGroupResource",
        engine="string",
        engine_version="string",
        param_details=[{
            "param_name": "string",
            "param_value": "string",
        }],
        parameter_group_name="string",
        parameter_group_desc="string")
    
    const rdsParameterGroupResource = new alicloud.rds.RdsParameterGroup("rdsParameterGroupResource", {
        engine: "string",
        engineVersion: "string",
        paramDetails: [{
            paramName: "string",
            paramValue: "string",
        }],
        parameterGroupName: "string",
        parameterGroupDesc: "string",
    });
    
    type: alicloud:rds:RdsParameterGroup
    properties:
        engine: string
        engineVersion: string
        paramDetails:
            - paramName: string
              paramValue: string
        parameterGroupDesc: string
        parameterGroupName: string
    

    RdsParameterGroup 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 RdsParameterGroup resource accepts the following input properties:

    Engine string
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    EngineVersion string
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    ParamDetails List<Pulumi.AliCloud.Rds.Inputs.RdsParameterGroupParamDetail>
    Parameter list. See param_detail below.
    ParameterGroupName string
    The name of the parameter template.
    ParameterGroupDesc string
    The description of the parameter template.
    Engine string
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    EngineVersion string
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    ParamDetails []RdsParameterGroupParamDetailArgs
    Parameter list. See param_detail below.
    ParameterGroupName string
    The name of the parameter template.
    ParameterGroupDesc string
    The description of the parameter template.
    engine String
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engineVersion String
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    paramDetails List<RdsParameterGroupParamDetail>
    Parameter list. See param_detail below.
    parameterGroupName String
    The name of the parameter template.
    parameterGroupDesc String
    The description of the parameter template.
    engine string
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engineVersion string
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    paramDetails RdsParameterGroupParamDetail[]
    Parameter list. See param_detail below.
    parameterGroupName string
    The name of the parameter template.
    parameterGroupDesc string
    The description of the parameter template.
    engine str
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engine_version str
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    param_details Sequence[RdsParameterGroupParamDetailArgs]
    Parameter list. See param_detail below.
    parameter_group_name str
    The name of the parameter template.
    parameter_group_desc str
    The description of the parameter template.
    engine String
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engineVersion String
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    paramDetails List<Property Map>
    Parameter list. See param_detail below.
    parameterGroupName String
    The name of the parameter template.
    parameterGroupDesc String
    The description of the parameter template.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RdsParameterGroup 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 RdsParameterGroup Resource

    Get an existing RdsParameterGroup 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?: RdsParameterGroupState, opts?: CustomResourceOptions): RdsParameterGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            engine: Optional[str] = None,
            engine_version: Optional[str] = None,
            param_details: Optional[Sequence[RdsParameterGroupParamDetailArgs]] = None,
            parameter_group_desc: Optional[str] = None,
            parameter_group_name: Optional[str] = None) -> RdsParameterGroup
    func GetRdsParameterGroup(ctx *Context, name string, id IDInput, state *RdsParameterGroupState, opts ...ResourceOption) (*RdsParameterGroup, error)
    public static RdsParameterGroup Get(string name, Input<string> id, RdsParameterGroupState? state, CustomResourceOptions? opts = null)
    public static RdsParameterGroup get(String name, Output<String> id, RdsParameterGroupState 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:
    Engine string
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    EngineVersion string
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    ParamDetails List<Pulumi.AliCloud.Rds.Inputs.RdsParameterGroupParamDetail>
    Parameter list. See param_detail below.
    ParameterGroupDesc string
    The description of the parameter template.
    ParameterGroupName string
    The name of the parameter template.
    Engine string
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    EngineVersion string
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    ParamDetails []RdsParameterGroupParamDetailArgs
    Parameter list. See param_detail below.
    ParameterGroupDesc string
    The description of the parameter template.
    ParameterGroupName string
    The name of the parameter template.
    engine String
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engineVersion String
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    paramDetails List<RdsParameterGroupParamDetail>
    Parameter list. See param_detail below.
    parameterGroupDesc String
    The description of the parameter template.
    parameterGroupName String
    The name of the parameter template.
    engine string
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engineVersion string
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    paramDetails RdsParameterGroupParamDetail[]
    Parameter list. See param_detail below.
    parameterGroupDesc string
    The description of the parameter template.
    parameterGroupName string
    The name of the parameter template.
    engine str
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engine_version str
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    param_details Sequence[RdsParameterGroupParamDetailArgs]
    Parameter list. See param_detail below.
    parameter_group_desc str
    The description of the parameter template.
    parameter_group_name str
    The name of the parameter template.
    engine String
    The database engine. Valid values: mysql, mariadb, PostgreSQL.
    engineVersion String
    The version of the database engine. Valid values: mysql: 5.1, 5.5, 5.6, 5.7, 8.0; mariadb: 10.3; PostgreSQL: 10.0, 11.0, 12.0, 13.0, 14.0, 15.0.
    paramDetails List<Property Map>
    Parameter list. See param_detail below.
    parameterGroupDesc String
    The description of the parameter template.
    parameterGroupName String
    The name of the parameter template.

    Supporting Types

    RdsParameterGroupParamDetail, RdsParameterGroupParamDetailArgs

    ParamName string
    The name of a parameter.
    ParamValue string
    The value of a parameter.
    ParamName string
    The name of a parameter.
    ParamValue string
    The value of a parameter.
    paramName String
    The name of a parameter.
    paramValue String
    The value of a parameter.
    paramName string
    The name of a parameter.
    paramValue string
    The value of a parameter.
    param_name str
    The name of a parameter.
    param_value str
    The value of a parameter.
    paramName String
    The name of a parameter.
    paramValue String
    The value of a parameter.

    Import

    RDS Parameter Group can be imported using the id, e.g.

    $ pulumi import alicloud:rds/rdsParameterGroup:RdsParameterGroup example <id>
    

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.69.0 published on Monday, Dec 9, 2024 by Pulumi