Alibaba Cloud v3.34.0, Mar 17 23

alicloud.polardb.ParameterGroup

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

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = new AliCloud.PolarDB.ParameterGroup("example", new()
    {
        DbType = "MySQL",
        DbVersion = "8.0",
        Description = "example_value",
        Parameters = new[]
        {
            new AliCloud.PolarDB.Inputs.ParameterGroupParameterArgs
            {
                ParamName = "wait_timeout",
                ParamValue = "86400",
            },
        },
    });

});

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{
			DbType:      pulumi.String("MySQL"),
			DbVersion:   pulumi.String("8.0"),
			Description: pulumi.String("example_value"),
			Parameters: polardb.ParameterGroupParameterArray{
				&polardb.ParameterGroupParameterArgs{
					ParamName:  pulumi.String("wait_timeout"),
					ParamValue: pulumi.String("86400"),
				},
			},
		})
		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.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()        
            .dbType("MySQL")
            .dbVersion("8.0")
            .description("example_value")
            .parameters(ParameterGroupParameterArgs.builder()
                .paramName("wait_timeout")
                .paramValue("86400")
                .build())
            .build());

    }
}

import pulumi
import pulumi_alicloud as alicloud

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

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

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

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

Create ParameterGroup Resource

new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);

@overload
def ParameterGroup(resource_name: 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)
@overload
def ParameterGroup(resource_name: str,
                   args: ParameterGroupArgs,
                   opts: Optional[ResourceOptions] = 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.

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.

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.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 []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<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 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.

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.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 []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<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 ParameterGroupParameterArgs[]: 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

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>

Package Details

Repository: Alibaba Cloud pulumi/pulumi-alicloud
License: Apache-2.0
Notes: This Pulumi package is based on the alicloud Terraform Provider.