Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. ParameterGroup
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.redis.ParameterGroup

Explore with Pulumi AI

volcengine logo
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine
volcengine/pulumi-volcengine

    Provides a resource to manage redis parameter group

    Example Usage

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

const foo = new volcengine.redis.ParameterGroup("foo", {
    description: "tf-test-description",
    engineVersion: "5.0",
    paramValues: [
        {
            name: "active-defrag-cycle-max",
            value: "30",
        },
        {
            name: "active-defrag-cycle-min",
            value: "15",
        },
    ],
});

    import pulumi
import pulumi_volcengine as volcengine

foo = volcengine.redis.ParameterGroup("foo",
    description="tf-test-description",
    engine_version="5.0",
    param_values=[
        volcengine.redis.ParameterGroupParamValueArgs(
            name="active-defrag-cycle-max",
            value="30",
        ),
        volcengine.redis.ParameterGroupParamValueArgs(
            name="active-defrag-cycle-min",
            value="15",
        ),
    ])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redis.NewParameterGroup(ctx, "foo", &redis.ParameterGroupArgs{
			Description:   pulumi.String("tf-test-description"),
			EngineVersion: pulumi.String("5.0"),
			ParamValues: redis.ParameterGroupParamValueArray{
				&redis.ParameterGroupParamValueArgs{
					Name:  pulumi.String("active-defrag-cycle-max"),
					Value: pulumi.String("30"),
				},
				&redis.ParameterGroupParamValueArgs{
					Name:  pulumi.String("active-defrag-cycle-min"),
					Value: pulumi.String("15"),
				},
			},
		})
		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 foo = new Volcengine.Redis.ParameterGroup("foo", new()
    {
        Description = "tf-test-description",
        EngineVersion = "5.0",
        ParamValues = new[]
        {
            new Volcengine.Redis.Inputs.ParameterGroupParamValueArgs
            {
                Name = "active-defrag-cycle-max",
                Value = "30",
            },
            new Volcengine.Redis.Inputs.ParameterGroupParamValueArgs
            {
                Name = "active-defrag-cycle-min",
                Value = "15",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.redis.ParameterGroup;
import com.pulumi.volcengine.redis.ParameterGroupArgs;
import com.pulumi.volcengine.redis.inputs.ParameterGroupParamValueArgs;
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 ParameterGroup("foo", ParameterGroupArgs.builder()        
            .description("tf-test-description")
            .engineVersion("5.0")
            .paramValues(            
                ParameterGroupParamValueArgs.builder()
                    .name("active-defrag-cycle-max")
                    .value("30")
                    .build(),
                ParameterGroupParamValueArgs.builder()
                    .name("active-defrag-cycle-min")
                    .value("15")
                    .build())
            .build());

    }
}

    resources:
  foo:
    type: volcengine:redis:ParameterGroup
    properties:
      description: tf-test-description
      engineVersion: '5.0'
      paramValues:
        - name: active-defrag-cycle-max
          value: '30'
        - name: active-defrag-cycle-min
          value: '15'

    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,
                   engine_version: Optional[str] = None,
                   param_values: Optional[Sequence[ParameterGroupParamValueArgs]] = 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: volcengine:redis: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 Volcengine.Redis.ParameterGroup("parameterGroupResource", new()
{
    EngineVersion = "string",
    ParamValues = new[]
    {
        new Volcengine.Redis.Inputs.ParameterGroupParamValueArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    Description = "string",
    Name = "string",
});

    example, err := redis.NewParameterGroup(ctx, "parameterGroupResource", &redis.ParameterGroupArgs{
	EngineVersion: pulumi.String("string"),
	ParamValues: redis.ParameterGroupParamValueArray{
		&redis.ParameterGroupParamValueArgs{
			Name:  pulumi.String("string"),
			Value: pulumi.String("string"),
		},
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var parameterGroupResource = new ParameterGroup("parameterGroupResource", ParameterGroupArgs.builder()
    .engineVersion("string")
    .paramValues(ParameterGroupParamValueArgs.builder()
        .name("string")
        .value("string")
        .build())
    .description("string")
    .name("string")
    .build());

    parameter_group_resource = volcengine.redis.ParameterGroup("parameterGroupResource",
    engine_version="string",
    param_values=[{
        "name": "string",
        "value": "string",
    }],
    description="string",
    name="string")

    const parameterGroupResource = new volcengine.redis.ParameterGroup("parameterGroupResource", {
    engineVersion: "string",
    paramValues: [{
        name: "string",
        value: "string",
    }],
    description: "string",
    name: "string",
});

    type: volcengine:redis:ParameterGroup
properties:
    description: string
    engineVersion: string
    name: string
    paramValues:
        - name: string
          value: 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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ParameterGroup resource accepts the following input properties:

    EngineVersion string
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    ParamValues List<ParameterGroupParamValue>
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    Description string
    The remarks information of the parameter template should not exceed 200 characters in length.
    Name string
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    EngineVersion string
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    ParamValues []ParameterGroupParamValueArgs
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    Description string
    The remarks information of the parameter template should not exceed 200 characters in length.
    Name string
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    engineVersion String
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    paramValues List<ParameterGroupParamValue>
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description String
    The remarks information of the parameter template should not exceed 200 characters in length.
    name String
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    engineVersion string
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    paramValues ParameterGroupParamValue[]
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description string
    The remarks information of the parameter template should not exceed 200 characters in length.
    name string
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    engine_version str
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    param_values Sequence[ParameterGroupParamValueArgs]
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description str
    The remarks information of the parameter template should not exceed 200 characters in length.
    name str
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    engineVersion String
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    paramValues List<Property Map>
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description String
    The remarks information of the parameter template should not exceed 200 characters in length.
    name String
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 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,
        description: Optional[str] = None,
        engine_version: Optional[str] = None,
        name: Optional[str] = None,
        param_values: Optional[Sequence[ParameterGroupParamValueArgs]] = 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)
    resources:  _:    type: volcengine:redis:ParameterGroup    get:      id: ${id}
    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:
    Description string
    The remarks information of the parameter template should not exceed 200 characters in length.
    EngineVersion string
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    Name string
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    ParamValues List<ParameterGroupParamValue>
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    Description string
    The remarks information of the parameter template should not exceed 200 characters in length.
    EngineVersion string
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    Name string
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    ParamValues []ParameterGroupParamValueArgs
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description String
    The remarks information of the parameter template should not exceed 200 characters in length.
    engineVersion String
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    name String
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    paramValues List<ParameterGroupParamValue>
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description string
    The remarks information of the parameter template should not exceed 200 characters in length.
    engineVersion string
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    name string
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    paramValues ParameterGroupParamValue[]
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description str
    The remarks information of the parameter template should not exceed 200 characters in length.
    engine_version str
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    name str
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    param_values Sequence[ParameterGroupParamValueArgs]
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.
    description String
    The remarks information of the parameter template should not exceed 200 characters in length.
    engineVersion String
    The Redis database version adapted to the parameter template. The value range is as follows; 7.0: Redis 7.0. 6.0: Redis 6.0. 5.0: Redis 5.0.
    name String
    Parameter template name. The name needs to meet the following requirements simultaneously: It cannot start with a number or a hyphen (-). Only Chinese characters, letters, numbers, underscores (_) and hyphens (-) can be included. The length should be 2 to 64 characters.
    paramValues List<Property Map>
    The list of parameter information that needs to be included in the new parameter template. If this attribute is set, please use lifecycle and ignore_changes ignore changes in fields.

    Supporting Types

    ParameterGroupParamValue, ParameterGroupParamValueArgs

    Name string
    The parameter names that need to be included in the parameter template.
    Value string
    The parameter values set for the corresponding parameters.
    Name string
    The parameter names that need to be included in the parameter template.
    Value string
    The parameter values set for the corresponding parameters.
    name String
    The parameter names that need to be included in the parameter template.
    value String
    The parameter values set for the corresponding parameters.
    name string
    The parameter names that need to be included in the parameter template.
    value string
    The parameter values set for the corresponding parameters.
    name str
    The parameter names that need to be included in the parameter template.
    value str
    The parameter values set for the corresponding parameters.
    name String
    The parameter names that need to be included in the parameter template.
    value String
    The parameter values set for the corresponding parameters.

    Import

    ParameterGroup can be imported using the id, e.g.

    $ pulumi import volcengine:redis/parameterGroup:ParameterGroup default resource_id

    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.34 published on Wednesday, Jul 2, 2025 by Volcengine
    volcengine/pulumi-volcengine