1. Packages
  2. Volcengine
  3. API Docs
  4. redis
  5. getParameterGroups
Volcengine v0.0.34 published on Wednesday, Jul 2, 2025 by Volcengine

volcengine.redis.getParameterGroups

Explore with Pulumi AI

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

    Use this data source to query detailed information of redis parameter groups

    Using getParameterGroups

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getParameterGroups(args: GetParameterGroupsArgs, opts?: InvokeOptions): Promise<GetParameterGroupsResult>
    function getParameterGroupsOutput(args: GetParameterGroupsOutputArgs, opts?: InvokeOptions): Output<GetParameterGroupsResult>
    def get_parameter_groups(engine_version: Optional[str] = None,
                             name_regex: Optional[str] = None,
                             output_file: Optional[str] = None,
                             source: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetParameterGroupsResult
    def get_parameter_groups_output(engine_version: Optional[pulumi.Input[str]] = None,
                             name_regex: Optional[pulumi.Input[str]] = None,
                             output_file: Optional[pulumi.Input[str]] = None,
                             source: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetParameterGroupsResult]
    func GetParameterGroups(ctx *Context, args *GetParameterGroupsArgs, opts ...InvokeOption) (*GetParameterGroupsResult, error)
    func GetParameterGroupsOutput(ctx *Context, args *GetParameterGroupsOutputArgs, opts ...InvokeOption) GetParameterGroupsResultOutput

    > Note: This function is named GetParameterGroups in the Go SDK.

    public static class GetParameterGroups 
    {
        public static Task<GetParameterGroupsResult> InvokeAsync(GetParameterGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetParameterGroupsResult> Invoke(GetParameterGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetParameterGroupsResult> getParameterGroups(GetParameterGroupsArgs args, InvokeOptions options)
    public static Output<GetParameterGroupsResult> getParameterGroups(GetParameterGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: volcengine:redis/getParameterGroups:getParameterGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    EngineVersion string
    The Redis database version applicable to the parameter template.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    Source string
    The source of creating the parameter template.
    EngineVersion string
    The Redis database version applicable to the parameter template.
    NameRegex string
    A Name Regex of Resource.
    OutputFile string
    File name where to save data source results.
    Source string
    The source of creating the parameter template.
    engineVersion String
    The Redis database version applicable to the parameter template.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    source String
    The source of creating the parameter template.
    engineVersion string
    The Redis database version applicable to the parameter template.
    nameRegex string
    A Name Regex of Resource.
    outputFile string
    File name where to save data source results.
    source string
    The source of creating the parameter template.
    engine_version str
    The Redis database version applicable to the parameter template.
    name_regex str
    A Name Regex of Resource.
    output_file str
    File name where to save data source results.
    source str
    The source of creating the parameter template.
    engineVersion String
    The Redis database version applicable to the parameter template.
    nameRegex String
    A Name Regex of Resource.
    outputFile String
    File name where to save data source results.
    source String
    The source of creating the parameter template.

    getParameterGroups Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    ParameterGroups List<GetParameterGroupsParameterGroup>
    The details of the parameter template.
    TotalCount int
    The total count of query.
    EngineVersion string
    The database version applicable to the parameter template.
    NameRegex string
    OutputFile string
    Source string
    The source of creating the parameter template.
    Id string
    The provider-assigned unique ID for this managed resource.
    ParameterGroups []GetParameterGroupsParameterGroup
    The details of the parameter template.
    TotalCount int
    The total count of query.
    EngineVersion string
    The database version applicable to the parameter template.
    NameRegex string
    OutputFile string
    Source string
    The source of creating the parameter template.
    id String
    The provider-assigned unique ID for this managed resource.
    parameterGroups List<GetParameterGroupsParameterGroup>
    The details of the parameter template.
    totalCount Integer
    The total count of query.
    engineVersion String
    The database version applicable to the parameter template.
    nameRegex String
    outputFile String
    source String
    The source of creating the parameter template.
    id string
    The provider-assigned unique ID for this managed resource.
    parameterGroups GetParameterGroupsParameterGroup[]
    The details of the parameter template.
    totalCount number
    The total count of query.
    engineVersion string
    The database version applicable to the parameter template.
    nameRegex string
    outputFile string
    source string
    The source of creating the parameter template.
    id str
    The provider-assigned unique ID for this managed resource.
    parameter_groups Sequence[GetParameterGroupsParameterGroup]
    The details of the parameter template.
    total_count int
    The total count of query.
    engine_version str
    The database version applicable to the parameter template.
    name_regex str
    output_file str
    source str
    The source of creating the parameter template.
    id String
    The provider-assigned unique ID for this managed resource.
    parameterGroups List<Property Map>
    The details of the parameter template.
    totalCount Number
    The total count of query.
    engineVersion String
    The database version applicable to the parameter template.
    nameRegex String
    outputFile String
    source String
    The source of creating the parameter template.

    Supporting Types

    GetParameterGroupsParameterGroup

    CreateTime string
    The creation time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    Default bool
    Whether it is the default parameter template.
    Description string
    The description the Optional parameters.
    EngineVersion string
    The Redis database version applicable to the parameter template.
    Name string
    The name of the parameter template.
    ParameterGroupId string
    The ID of the parameter template.
    ParameterNum int
    The number of parameters contained in the parameter template.
    Parameters List<GetParameterGroupsParameterGroupParameter>
    The list of parameter information contained in the parameter template.
    Source string
    The source of creating the parameter template.
    UpdateTime string
    The last update time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    CreateTime string
    The creation time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    Default bool
    Whether it is the default parameter template.
    Description string
    The description the Optional parameters.
    EngineVersion string
    The Redis database version applicable to the parameter template.
    Name string
    The name of the parameter template.
    ParameterGroupId string
    The ID of the parameter template.
    ParameterNum int
    The number of parameters contained in the parameter template.
    Parameters []GetParameterGroupsParameterGroupParameter
    The list of parameter information contained in the parameter template.
    Source string
    The source of creating the parameter template.
    UpdateTime string
    The last update time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    createTime String
    The creation time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    default_ Boolean
    Whether it is the default parameter template.
    description String
    The description the Optional parameters.
    engineVersion String
    The Redis database version applicable to the parameter template.
    name String
    The name of the parameter template.
    parameterGroupId String
    The ID of the parameter template.
    parameterNum Integer
    The number of parameters contained in the parameter template.
    parameters List<GetParameterGroupsParameterGroupParameter>
    The list of parameter information contained in the parameter template.
    source String
    The source of creating the parameter template.
    updateTime String
    The last update time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    createTime string
    The creation time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    default boolean
    Whether it is the default parameter template.
    description string
    The description the Optional parameters.
    engineVersion string
    The Redis database version applicable to the parameter template.
    name string
    The name of the parameter template.
    parameterGroupId string
    The ID of the parameter template.
    parameterNum number
    The number of parameters contained in the parameter template.
    parameters GetParameterGroupsParameterGroupParameter[]
    The list of parameter information contained in the parameter template.
    source string
    The source of creating the parameter template.
    updateTime string
    The last update time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    create_time str
    The creation time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    default bool
    Whether it is the default parameter template.
    description str
    The description the Optional parameters.
    engine_version str
    The Redis database version applicable to the parameter template.
    name str
    The name of the parameter template.
    parameter_group_id str
    The ID of the parameter template.
    parameter_num int
    The number of parameters contained in the parameter template.
    parameters Sequence[GetParameterGroupsParameterGroupParameter]
    The list of parameter information contained in the parameter template.
    source str
    The source of creating the parameter template.
    update_time str
    The last update time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    createTime String
    The creation time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).
    default Boolean
    Whether it is the default parameter template.
    description String
    The description the Optional parameters.
    engineVersion String
    The Redis database version applicable to the parameter template.
    name String
    The name of the parameter template.
    parameterGroupId String
    The ID of the parameter template.
    parameterNum Number
    The number of parameters contained in the parameter template.
    parameters List<Property Map>
    The list of parameter information contained in the parameter template.
    source String
    The source of creating the parameter template.
    updateTime String
    The last update time of the parameter template, in the format of yyyy-MM-ddTHH:mm:ssZ (UTC).

    GetParameterGroupsParameterGroupParameter

    CurrentValue string
    The current running value of the parameter.
    Description string
    The description the Optional parameters.
    NeedReboot bool
    Whether to restart the instance to take effect after modifying this parameter.
    Options List<GetParameterGroupsParameterGroupParameterOption>
    The optional list of selector type parameters.
    ParamName string
    The name of parameter.
    Range string
    The value range of numerical type parameters.
    Type string
    The type of the parameter.
    Unit string
    The unit of the numerical type parameter.
    CurrentValue string
    The current running value of the parameter.
    Description string
    The description the Optional parameters.
    NeedReboot bool
    Whether to restart the instance to take effect after modifying this parameter.
    Options []GetParameterGroupsParameterGroupParameterOption
    The optional list of selector type parameters.
    ParamName string
    The name of parameter.
    Range string
    The value range of numerical type parameters.
    Type string
    The type of the parameter.
    Unit string
    The unit of the numerical type parameter.
    currentValue String
    The current running value of the parameter.
    description String
    The description the Optional parameters.
    needReboot Boolean
    Whether to restart the instance to take effect after modifying this parameter.
    options List<GetParameterGroupsParameterGroupParameterOption>
    The optional list of selector type parameters.
    paramName String
    The name of parameter.
    range String
    The value range of numerical type parameters.
    type String
    The type of the parameter.
    unit String
    The unit of the numerical type parameter.
    currentValue string
    The current running value of the parameter.
    description string
    The description the Optional parameters.
    needReboot boolean
    Whether to restart the instance to take effect after modifying this parameter.
    options GetParameterGroupsParameterGroupParameterOption[]
    The optional list of selector type parameters.
    paramName string
    The name of parameter.
    range string
    The value range of numerical type parameters.
    type string
    The type of the parameter.
    unit string
    The unit of the numerical type parameter.
    current_value str
    The current running value of the parameter.
    description str
    The description the Optional parameters.
    need_reboot bool
    Whether to restart the instance to take effect after modifying this parameter.
    options Sequence[GetParameterGroupsParameterGroupParameterOption]
    The optional list of selector type parameters.
    param_name str
    The name of parameter.
    range str
    The value range of numerical type parameters.
    type str
    The type of the parameter.
    unit str
    The unit of the numerical type parameter.
    currentValue String
    The current running value of the parameter.
    description String
    The description the Optional parameters.
    needReboot Boolean
    Whether to restart the instance to take effect after modifying this parameter.
    options List<Property Map>
    The optional list of selector type parameters.
    paramName String
    The name of parameter.
    range String
    The value range of numerical type parameters.
    type String
    The type of the parameter.
    unit String
    The unit of the numerical type parameter.

    GetParameterGroupsParameterGroupParameterOption

    Description string
    The description the Optional parameters.
    Value string
    Optional selector type parameters.
    Description string
    The description the Optional parameters.
    Value string
    Optional selector type parameters.
    description String
    The description the Optional parameters.
    value String
    Optional selector type parameters.
    description string
    The description the Optional parameters.
    value string
    Optional selector type parameters.
    description str
    The description the Optional parameters.
    value str
    Optional selector type parameters.
    description String
    The description the Optional parameters.
    value String
    Optional selector type parameters.

    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