1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. redis
  6. ParameterGroup
Viewing docs for volcenginecc v0.0.38
published on Monday, May 25, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.38
published on Monday, May 25, 2026 by Volcengine

    Volcano Engine Cloud Database Redis Edition parameter group, used to manage and apply Redis instance parameter configurations in bulk

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@pulumi/volcenginecc";
    
    const redisParameterGroupDemo = new volcenginecc.index.RedisParametergroup("RedisParameterGroupDemo", {
        engineVersion: "6.0",
        description: "用于测试的Redis 6.0自定义参数组",
        paramValues: [
            {
                value: "allkeys-lru",
                name: "maxmemory-policy",
            },
            {
                value: "300",
                name: "proxy-client-idle-timeout",
            },
        ],
        name: "test-redis6-param-group",
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    redis_parameter_group_demo = volcenginecc.index.RedisParametergroup("RedisParameterGroupDemo",
        engine_version=6.0,
        description=用于测试的Redis 6.0自定义参数组,
        param_values=[
            {
                value: allkeys-lru,
                name: maxmemory-policy,
            },
            {
                value: 300,
                name: proxy-client-idle-timeout,
            },
        ],
        name=test-redis6-param-group)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := volcenginecc.NewRedisParametergroup(ctx, "RedisParameterGroupDemo", &volcenginecc.RedisParametergroupArgs{
    			EngineVersion: "6.0",
    			Description:   "用于测试的Redis 6.0自定义参数组",
    			ParamValues: []map[string]interface{}{
    				map[string]interface{}{
    					"value": "allkeys-lru",
    					"name":  "maxmemory-policy",
    				},
    				map[string]interface{}{
    					"value": "300",
    					"name":  "proxy-client-idle-timeout",
    				},
    			},
    			Name: "test-redis6-param-group",
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var redisParameterGroupDemo = new Volcenginecc.Index.RedisParametergroup("RedisParameterGroupDemo", new()
        {
            EngineVersion = "6.0",
            Description = "用于测试的Redis 6.0自定义参数组",
            ParamValues = new[]
            {
                
                {
                    { "value", "allkeys-lru" },
                    { "name", "maxmemory-policy" },
                },
                
                {
                    { "value", "300" },
                    { "name", "proxy-client-idle-timeout" },
                },
            },
            Name = "test-redis6-param-group",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.volcenginecc.redisParametergroup;
    import com.pulumi.volcenginecc.redisParametergroupArgs;
    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 redisParameterGroupDemo = new RedisParametergroup("redisParameterGroupDemo", RedisParametergroupArgs.builder()
                .engineVersion("6.0")
                .description("用于测试的Redis 6.0自定义参数组")
                .paramValues(List.of(            
                    Map.ofEntries(
                        Map.entry("value", "allkeys-lru"),
                        Map.entry("name", "maxmemory-policy")
                    ),
                    Map.ofEntries(
                        Map.entry("value", "300"),
                        Map.entry("name", "proxy-client-idle-timeout")
                    )))
                .name("test-redis6-param-group")
                .build());
    
        }
    }
    
    resources:
      redisParameterGroupDemo:
        type: volcenginecc:redisParametergroup
        name: RedisParameterGroupDemo
        properties:
          engineVersion: '6.0'
          description: 用于测试的Redis 6.0自定义参数组
          paramValues:
            - value: allkeys-lru
              name: maxmemory-policy
            - value: '300'
              name: proxy-client-idle-timeout
          name: test-redis6-param-group
    
    Example coming soon!
    

    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,
                       name: Optional[str] = None,
                       param_values: Optional[Sequence[ParameterGroupParamValueArgs]] = None,
                       description: 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: volcenginecc:redis:ParameterGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcenginecc_redis_parametergroup" "name" {
        # resource properties
    }

    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 Volcenginecc.Redis.ParameterGroup("parameterGroupResource", new()
    {
        EngineVersion = "string",
        Name = "string",
        ParamValues = new[]
        {
            new Volcenginecc.Redis.Inputs.ParameterGroupParamValueArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        Description = "string",
    });
    
    example, err := redis.NewParameterGroup(ctx, "parameterGroupResource", &redis.ParameterGroupArgs{
    	EngineVersion: pulumi.String("string"),
    	Name:          pulumi.String("string"),
    	ParamValues: redis.ParameterGroupParamValueArray{
    		&redis.ParameterGroupParamValueArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    })
    
    resource "volcenginecc_redis_parametergroup" "parameterGroupResource" {
      engine_version = "string"
      name           = "string"
      param_values {
        name  = "string"
        value = "string"
      }
      description = "string"
    }
    
    var parameterGroupResource = new ParameterGroup("parameterGroupResource", ParameterGroupArgs.builder()
        .engineVersion("string")
        .name("string")
        .paramValues(ParameterGroupParamValueArgs.builder()
            .name("string")
            .value("string")
            .build())
        .description("string")
        .build());
    
    parameter_group_resource = volcenginecc.redis.ParameterGroup("parameterGroupResource",
        engine_version="string",
        name="string",
        param_values=[{
            "name": "string",
            "value": "string",
        }],
        description="string")
    
    const parameterGroupResource = new volcenginecc.redis.ParameterGroup("parameterGroupResource", {
        engineVersion: "string",
        name: "string",
        paramValues: [{
            name: "string",
            value: "string",
        }],
        description: "string",
    });
    
    type: volcenginecc: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
    Redis engine version for the parameter group
    Name string
    Parameter group name
    ParamValues List<Volcengine.ParameterGroupParamValue>
    Description string
    Parameter group description
    EngineVersion string
    Redis engine version for the parameter group
    Name string
    Parameter group name
    ParamValues []ParameterGroupParamValueArgs
    Description string
    Parameter group description
    engine_version string
    Redis engine version for the parameter group
    name string
    Parameter group name
    param_values list(object)
    description string
    Parameter group description
    engineVersion String
    Redis engine version for the parameter group
    name String
    Parameter group name
    paramValues List<ParameterGroupParamValue>
    description String
    Parameter group description
    engineVersion string
    Redis engine version for the parameter group
    name string
    Parameter group name
    paramValues ParameterGroupParamValue[]
    description string
    Parameter group description
    engine_version str
    Redis engine version for the parameter group
    name str
    Parameter group name
    param_values Sequence[ParameterGroupParamValueArgs]
    description str
    Parameter group description
    engineVersion String
    Redis engine version for the parameter group
    name String
    Parameter group name
    paramValues List<Property Map>
    description String
    Parameter group description

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ParameterGroup resource produces the following output properties:

    CreateTime string
    Parameter group creation time
    Default bool
    Whether it is the default parameter group
    Id string
    The provider-assigned unique ID for this managed resource.
    ParameterGroupId string
    Parameter group ID, automatically generated by the system
    Parameters List<Volcengine.ParameterGroupParameter>
    Source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    UpdateTime string
    Parameter group update time
    CreateTime string
    Parameter group creation time
    Default bool
    Whether it is the default parameter group
    Id string
    The provider-assigned unique ID for this managed resource.
    ParameterGroupId string
    Parameter group ID, automatically generated by the system
    Parameters []ParameterGroupParameter
    Source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    UpdateTime string
    Parameter group update time
    create_time string
    Parameter group creation time
    default bool
    Whether it is the default parameter group
    id string
    The provider-assigned unique ID for this managed resource.
    parameter_group_id string
    Parameter group ID, automatically generated by the system
    parameters list(object)
    source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    update_time string
    Parameter group update time
    createTime String
    Parameter group creation time
    default_ Boolean
    Whether it is the default parameter group
    id String
    The provider-assigned unique ID for this managed resource.
    parameterGroupId String
    Parameter group ID, automatically generated by the system
    parameters List<ParameterGroupParameter>
    source String
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    updateTime String
    Parameter group update time
    createTime string
    Parameter group creation time
    default boolean
    Whether it is the default parameter group
    id string
    The provider-assigned unique ID for this managed resource.
    parameterGroupId string
    Parameter group ID, automatically generated by the system
    parameters ParameterGroupParameter[]
    source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    updateTime string
    Parameter group update time
    create_time str
    Parameter group creation time
    default bool
    Whether it is the default parameter group
    id str
    The provider-assigned unique ID for this managed resource.
    parameter_group_id str
    Parameter group ID, automatically generated by the system
    parameters Sequence[ParameterGroupParameter]
    source str
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    update_time str
    Parameter group update time
    createTime String
    Parameter group creation time
    default Boolean
    Whether it is the default parameter group
    id String
    The provider-assigned unique ID for this managed resource.
    parameterGroupId String
    Parameter group ID, automatically generated by the system
    parameters List<Property Map>
    source String
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    updateTime String
    Parameter group update time

    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,
            create_time: Optional[str] = None,
            default: Optional[bool] = None,
            description: Optional[str] = None,
            engine_version: Optional[str] = None,
            name: Optional[str] = None,
            param_values: Optional[Sequence[ParameterGroupParamValueArgs]] = None,
            parameter_group_id: Optional[str] = None,
            parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
            source: Optional[str] = None,
            update_time: Optional[str] = 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: volcenginecc:redis:ParameterGroup    get:      id: ${id}
    import {
      to = volcenginecc_redis_parametergroup.example
      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:
    CreateTime string
    Parameter group creation time
    Default bool
    Whether it is the default parameter group
    Description string
    Parameter group description
    EngineVersion string
    Redis engine version for the parameter group
    Name string
    Parameter group name
    ParamValues List<Volcengine.ParameterGroupParamValue>
    ParameterGroupId string
    Parameter group ID, automatically generated by the system
    Parameters List<Volcengine.ParameterGroupParameter>
    Source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    UpdateTime string
    Parameter group update time
    CreateTime string
    Parameter group creation time
    Default bool
    Whether it is the default parameter group
    Description string
    Parameter group description
    EngineVersion string
    Redis engine version for the parameter group
    Name string
    Parameter group name
    ParamValues []ParameterGroupParamValueArgs
    ParameterGroupId string
    Parameter group ID, automatically generated by the system
    Parameters []ParameterGroupParameterArgs
    Source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    UpdateTime string
    Parameter group update time
    create_time string
    Parameter group creation time
    default bool
    Whether it is the default parameter group
    description string
    Parameter group description
    engine_version string
    Redis engine version for the parameter group
    name string
    Parameter group name
    param_values list(object)
    parameter_group_id string
    Parameter group ID, automatically generated by the system
    parameters list(object)
    source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    update_time string
    Parameter group update time
    createTime String
    Parameter group creation time
    default_ Boolean
    Whether it is the default parameter group
    description String
    Parameter group description
    engineVersion String
    Redis engine version for the parameter group
    name String
    Parameter group name
    paramValues List<ParameterGroupParamValue>
    parameterGroupId String
    Parameter group ID, automatically generated by the system
    parameters List<ParameterGroupParameter>
    source String
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    updateTime String
    Parameter group update time
    createTime string
    Parameter group creation time
    default boolean
    Whether it is the default parameter group
    description string
    Parameter group description
    engineVersion string
    Redis engine version for the parameter group
    name string
    Parameter group name
    paramValues ParameterGroupParamValue[]
    parameterGroupId string
    Parameter group ID, automatically generated by the system
    parameters ParameterGroupParameter[]
    source string
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    updateTime string
    Parameter group update time
    create_time str
    Parameter group creation time
    default bool
    Whether it is the default parameter group
    description str
    Parameter group description
    engine_version str
    Redis engine version for the parameter group
    name str
    Parameter group name
    param_values Sequence[ParameterGroupParamValueArgs]
    parameter_group_id str
    Parameter group ID, automatically generated by the system
    parameters Sequence[ParameterGroupParameterArgs]
    source str
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    update_time str
    Parameter group update time
    createTime String
    Parameter group creation time
    default Boolean
    Whether it is the default parameter group
    description String
    Parameter group description
    engineVersion String
    Redis engine version for the parameter group
    name String
    Parameter group name
    paramValues List<Property Map>
    parameterGroupId String
    Parameter group ID, automatically generated by the system
    parameters List<Property Map>
    source String
    Parameter group source. Values: System (system parameter group), User (user parameter group)
    updateTime String
    Parameter group update time

    Supporting Types

    ParameterGroupParamValue, ParameterGroupParamValueArgs

    Name string
    Parameter name
    Value string
    Parameter value
    Name string
    Parameter name
    Value string
    Parameter value
    name string
    Parameter name
    value string
    Parameter value
    name String
    Parameter name
    value String
    Parameter value
    name string
    Parameter name
    value string
    Parameter value
    name str
    Parameter name
    value str
    Parameter value
    name String
    Parameter name
    value String
    Parameter value

    ParameterGroupParameter, ParameterGroupParameterArgs

    CurrentValue string
    Current parameter value
    Description string
    Parameter description
    NeedReboot bool
    Whether modifying this parameter requires a restart
    ParamName string
    Parameter name
    Range string
    Parameter value range
    Type string
    Parameter type
    Unit string
    Parameter unit
    CurrentValue string
    Current parameter value
    Description string
    Parameter description
    NeedReboot bool
    Whether modifying this parameter requires a restart
    ParamName string
    Parameter name
    Range string
    Parameter value range
    Type string
    Parameter type
    Unit string
    Parameter unit
    current_value string
    Current parameter value
    description string
    Parameter description
    need_reboot bool
    Whether modifying this parameter requires a restart
    param_name string
    Parameter name
    range string
    Parameter value range
    type string
    Parameter type
    unit string
    Parameter unit
    currentValue String
    Current parameter value
    description String
    Parameter description
    needReboot Boolean
    Whether modifying this parameter requires a restart
    paramName String
    Parameter name
    range String
    Parameter value range
    type String
    Parameter type
    unit String
    Parameter unit
    currentValue string
    Current parameter value
    description string
    Parameter description
    needReboot boolean
    Whether modifying this parameter requires a restart
    paramName string
    Parameter name
    range string
    Parameter value range
    type string
    Parameter type
    unit string
    Parameter unit
    current_value str
    Current parameter value
    description str
    Parameter description
    need_reboot bool
    Whether modifying this parameter requires a restart
    param_name str
    Parameter name
    range str
    Parameter value range
    type str
    Parameter type
    unit str
    Parameter unit
    currentValue String
    Current parameter value
    description String
    Parameter description
    needReboot Boolean
    Whether modifying this parameter requires a restart
    paramName String
    Parameter name
    range String
    Parameter value range
    type String
    Parameter type
    unit String
    Parameter unit

    Import

    $ pulumi import volcenginecc:redis/parameterGroup:ParameterGroup example "parameter_group_id"
    

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

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.38
    published on Monday, May 25, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial