Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alicloud Provider
  3. API Docs
  4. polardb
  5. ParameterGroup
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.polardb.ParameterGroup

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a PolarDB Parameter Group resource.

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

    NOTE: Available in v1.183.0+.

    Example Usage

    Basic Usage

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

const example = new alicloud.polardb.ParameterGroup("example", {
    name: "example_value",
    dbType: "MySQL",
    dbVersion: "8.0",
    parameters: [{
        paramName: "wait_timeout",
        paramValue: "86400",
    }],
    description: "example_value",
});

    import pulumi
import pulumi_alicloud as alicloud

example = alicloud.polardb.ParameterGroup("example",
    name="example_value",
    db_type="MySQL",
    db_version="8.0",
    parameters=[{
        "param_name": "wait_timeout",
        "param_value": "86400",
    }],
    description="example_value")

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/polardb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := polardb.NewParameterGroup(ctx, "example", &polardb.ParameterGroupArgs{
			Name:      pulumi.String("example_value"),
			DbType:    pulumi.String("MySQL"),
			DbVersion: pulumi.String("8.0"),
			Parameters: polardb.ParameterGroupParameterArray{
				&polardb.ParameterGroupParameterArgs{
					ParamName:  pulumi.String("wait_timeout"),
					ParamValue: pulumi.String("86400"),
				},
			},
			Description: pulumi.String("example_value"),
		})
		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 example = new AliCloud.PolarDB.ParameterGroup("example", new()
    {
        Name = "example_value",
        DbType = "MySQL",
        DbVersion = "8.0",
        Parameters = new[]
        {
            new AliCloud.PolarDB.Inputs.ParameterGroupParameterArgs
            {
                ParamName = "wait_timeout",
                ParamValue = "86400",
            },
        },
        Description = "example_value",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.polardb.ParameterGroup;
import com.pulumi.alicloud.polardb.ParameterGroupArgs;
import com.pulumi.alicloud.polardb.inputs.ParameterGroupParameterArgs;
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 example = new ParameterGroup("example", ParameterGroupArgs.builder()
            .name("example_value")
            .dbType("MySQL")
            .dbVersion("8.0")
            .parameters(ParameterGroupParameterArgs.builder()
                .paramName("wait_timeout")
                .paramValue("86400")
                .build())
            .description("example_value")
            .build());

    }
}

    resources:
  example:
    type: alicloud:polardb:ParameterGroup
    properties:
      name: example_value
      dbType: MySQL
      dbVersion: '8.0'
      parameters:
        - paramName: wait_timeout
          paramValue: '86400'
      description: example_value

    Create ParameterGroup Resource

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

    Constructor syntax

    new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);
    @overload
def ParameterGroup(resource_name: str,
                   args: ParameterGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ParameterGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   db_type: Optional[str] = None,
                   db_version: Optional[str] = None,
                   parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None)
    func NewParameterGroup(ctx *Context, name string, args ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)
    public ParameterGroup(string name, ParameterGroupArgs args, CustomResourceOptions? opts = null)
    public ParameterGroup(String name, ParameterGroupArgs args)
public ParameterGroup(String name, ParameterGroupArgs args, CustomResourceOptions options)

    type: alicloud:polardb:ParameterGroup
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 ParameterGroupArgs
    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 ParameterGroupArgs
    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 ParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ParameterGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ParameterGroupArgs
    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 parameterGroupResource = new AliCloud.PolarDB.ParameterGroup("parameterGroupResource", new()
{
    DbType = "string",
    DbVersion = "string",
    Parameters = new[]
    {
        new AliCloud.PolarDB.Inputs.ParameterGroupParameterArgs
        {
            ParamName = "string",
            ParamValue = "string",
        },
    },
    Description = "string",
    Name = "string",
});

    example, err := polardb.NewParameterGroup(ctx, "parameterGroupResource", &polardb.ParameterGroupArgs{
	DbType:    pulumi.String("string"),
	DbVersion: pulumi.String("string"),
	Parameters: polardb.ParameterGroupParameterArray{
		&polardb.ParameterGroupParameterArgs{
			ParamName:  pulumi.String("string"),
			ParamValue: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var parameterGroupResource = new ParameterGroup("parameterGroupResource", ParameterGroupArgs.builder()
    .dbType("string")
    .dbVersion("string")
    .parameters(ParameterGroupParameterArgs.builder()
        .paramName("string")
        .paramValue("string")
        .build())
    .description("string")
    .name("string")
    .build());

    parameter_group_resource = alicloud.polardb.ParameterGroup("parameterGroupResource",
    db_type="string",
    db_version="string",
    parameters=[alicloud.polardb.ParameterGroupParameterArgs(
        param_name="string",
        param_value="string",
    )],
    description="string",
    name="string")

    const parameterGroupResource = new alicloud.polardb.ParameterGroup("parameterGroupResource", {
    dbType: "string",
    dbVersion: "string",
    parameters: [{
        paramName: "string",
        paramValue: "string",
    }],
    description: "string",
    name: "string",
});

    type: alicloud:polardb:ParameterGroup
properties:
    dbType: string
    dbVersion: string
    description: string
    name: string
    parameters:
        - paramName: string
          paramValue: string

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

    DbType string
    The type of the database engine. Only MySQL is supported.
    DbVersion string
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    Parameters List<Pulumi.AliCloud.PolarDB.Inputs.ParameterGroupParameter>
    The parameter template. See the following Block parameters.
    Description string
    The description of the parameter template. It must be 0 to 200 characters in length.
    Name string
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    DbType string
    The type of the database engine. Only MySQL is supported.
    DbVersion string
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    Parameters []ParameterGroupParameterArgs
    The parameter template. See the following Block parameters.
    Description string
    The description of the parameter template. It must be 0 to 200 characters in length.
    Name string
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    dbType String
    The type of the database engine. Only MySQL is supported.
    dbVersion String
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    parameters List<ParameterGroupParameter>
    The parameter template. See the following Block parameters.
    description String
    The description of the parameter template. It must be 0 to 200 characters in length.
    name String
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    dbType string
    The type of the database engine. Only MySQL is supported.
    dbVersion string
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    parameters ParameterGroupParameter[]
    The parameter template. See the following Block parameters.
    description string
    The description of the parameter template. It must be 0 to 200 characters in length.
    name string
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    db_type str
    The type of the database engine. Only MySQL is supported.
    db_version str
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    parameters Sequence[ParameterGroupParameterArgs]
    The parameter template. See the following Block parameters.
    description str
    The description of the parameter template. It must be 0 to 200 characters in length.
    name str
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    dbType String
    The type of the database engine. Only MySQL is supported.
    dbVersion String
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    parameters List<Property Map>
    The parameter template. See the following Block parameters.
    description String
    The description of the parameter template. It must be 0 to 200 characters in length.
    name String
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.

    Outputs

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

    Get an existing ParameterGroup 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?: ParameterGroupState, opts?: CustomResourceOptions): ParameterGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        db_type: Optional[str] = None,
        db_version: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None) -> ParameterGroup
    func GetParameterGroup(ctx *Context, name string, id IDInput, state *ParameterGroupState, opts ...ResourceOption) (*ParameterGroup, error)
    public static ParameterGroup Get(string name, Input<string> id, ParameterGroupState? state, CustomResourceOptions? opts = null)
    public static ParameterGroup get(String name, Output<String> id, ParameterGroupState 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:
    DbType string
    The type of the database engine. Only MySQL is supported.
    DbVersion string
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    Description string
    The description of the parameter template. It must be 0 to 200 characters in length.
    Name string
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    Parameters List<Pulumi.AliCloud.PolarDB.Inputs.ParameterGroupParameter>
    The parameter template. See the following Block parameters.
    DbType string
    The type of the database engine. Only MySQL is supported.
    DbVersion string
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    Description string
    The description of the parameter template. It must be 0 to 200 characters in length.
    Name string
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    Parameters []ParameterGroupParameterArgs
    The parameter template. See the following Block parameters.
    dbType String
    The type of the database engine. Only MySQL is supported.
    dbVersion String
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    description String
    The description of the parameter template. It must be 0 to 200 characters in length.
    name String
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    parameters List<ParameterGroupParameter>
    The parameter template. See the following Block parameters.
    dbType string
    The type of the database engine. Only MySQL is supported.
    dbVersion string
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    description string
    The description of the parameter template. It must be 0 to 200 characters in length.
    name string
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    parameters ParameterGroupParameter[]
    The parameter template. See the following Block parameters.
    db_type str
    The type of the database engine. Only MySQL is supported.
    db_version str
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    description str
    The description of the parameter template. It must be 0 to 200 characters in length.
    name str
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    parameters Sequence[ParameterGroupParameterArgs]
    The parameter template. See the following Block parameters.
    dbType String
    The type of the database engine. Only MySQL is supported.
    dbVersion String
    The version number of the database engine. Valid values: 5.6, 5.7, 8.0.
    description String
    The description of the parameter template. It must be 0 to 200 characters in length.
    name String
    The name of the parameter template. It must be 8 to 64 characters in length, and can contain letters, digits, and underscores (_). It must start with a letter and cannot contain Chinese characters.
    parameters List<Property Map>
    The parameter template. See the following Block parameters.

    Supporting Types

    ParameterGroupParameter, ParameterGroupParameterArgs

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

    Import

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

    $ pulumi import alicloud:polardb/parameterGroup:ParameterGroup 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.62.1 published on Monday, Sep 16, 2024 by Pulumi
    pulumi/pulumi-alicloud