Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getRedisClusters
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getRedisClusters

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query detailed information of redis clusters

    Example Usage

    Query all instance

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

const clusters = tencentcloud.getRedisClusters({});

    import pulumi
import pulumi_tencentcloud as tencentcloud

clusters = tencentcloud.get_redis_clusters()

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetRedisClusters(ctx, &tencentcloud.GetRedisClustersArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var clusters = Tencentcloud.GetRedisClusters.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetRedisClustersArgs;
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) {
        final var clusters = TencentcloudFunctions.getRedisClusters();

    }
}

    variables:
  clusters:
    fn::invoke:
      function: tencentcloud:getRedisClusters
      arguments: {}

    Also Support the following query conditions

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

const clusters = tencentcloud.getRedisClusters({
    autoRenewFlags: [
        0,
        1,
        2,
    ],
    clusterName: "crs-cdc-9nyfki8h",
    dedicatedClusterId: "cluster-0astoh6a",
    projectIds: [
        0,
        1,
    ],
    redisClusterIds: ["crs-cdc-9nyfki8h"],
    statuses: [
        0,
        1,
        2,
    ],
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

clusters = tencentcloud.get_redis_clusters(auto_renew_flags=[
        0,
        1,
        2,
    ],
    cluster_name="crs-cdc-9nyfki8h",
    dedicated_cluster_id="cluster-0astoh6a",
    project_ids=[
        0,
        1,
    ],
    redis_cluster_ids=["crs-cdc-9nyfki8h"],
    statuses=[
        0,
        1,
        2,
    ])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetRedisClusters(ctx, &tencentcloud.GetRedisClustersArgs{
			AutoRenewFlags: []float64{
				0,
				1,
				2,
			},
			ClusterName:        pulumi.StringRef("crs-cdc-9nyfki8h"),
			DedicatedClusterId: pulumi.StringRef("cluster-0astoh6a"),
			ProjectIds: []float64{
				0,
				1,
			},
			RedisClusterIds: []string{
				"crs-cdc-9nyfki8h",
			},
			Statuses: []float64{
				0,
				1,
				2,
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var clusters = Tencentcloud.GetRedisClusters.Invoke(new()
    {
        AutoRenewFlags = new[]
        {
            0,
            1,
            2,
        },
        ClusterName = "crs-cdc-9nyfki8h",
        DedicatedClusterId = "cluster-0astoh6a",
        ProjectIds = new[]
        {
            0,
            1,
        },
        RedisClusterIds = new[]
        {
            "crs-cdc-9nyfki8h",
        },
        Statuses = new[]
        {
            0,
            1,
            2,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetRedisClustersArgs;
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) {
        final var clusters = TencentcloudFunctions.getRedisClusters(GetRedisClustersArgs.builder()
            .autoRenewFlags(            
                0,
                1,
                2)
            .clusterName("crs-cdc-9nyfki8h")
            .dedicatedClusterId("cluster-0astoh6a")
            .projectIds(            
                0,
                1)
            .redisClusterIds("crs-cdc-9nyfki8h")
            .statuses(            
                0,
                1,
                2)
            .build());

    }
}

    variables:
  clusters:
    fn::invoke:
      function: tencentcloud:getRedisClusters
      arguments:
        autoRenewFlags:
          - 0
          - 1
          - 2
        clusterName: crs-cdc-9nyfki8h
        dedicatedClusterId: cluster-0astoh6a
        projectIds:
          - 0
          - 1
        redisClusterIds:
          - crs-cdc-9nyfki8h
        statuses:
          - 0
          - 1
          - 2

    Using getRedisClusters

    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 getRedisClusters(args: GetRedisClustersArgs, opts?: InvokeOptions): Promise<GetRedisClustersResult>
function getRedisClustersOutput(args: GetRedisClustersOutputArgs, opts?: InvokeOptions): Output<GetRedisClustersResult>
    def get_redis_clusters(auto_renew_flags: Optional[Sequence[float]] = None,
                       cluster_name: Optional[str] = None,
                       dedicated_cluster_id: Optional[str] = None,
                       id: Optional[str] = None,
                       project_ids: Optional[Sequence[float]] = None,
                       redis_cluster_ids: Optional[Sequence[str]] = None,
                       result_output_file: Optional[str] = None,
                       statuses: Optional[Sequence[float]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRedisClustersResult
def get_redis_clusters_output(auto_renew_flags: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                       cluster_name: Optional[pulumi.Input[str]] = None,
                       dedicated_cluster_id: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       project_ids: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                       redis_cluster_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                       result_output_file: Optional[pulumi.Input[str]] = None,
                       statuses: Optional[pulumi.Input[Sequence[pulumi.Input[float]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetRedisClustersResult]
    func GetRedisClusters(ctx *Context, args *GetRedisClustersArgs, opts ...InvokeOption) (*GetRedisClustersResult, error)
func GetRedisClustersOutput(ctx *Context, args *GetRedisClustersOutputArgs, opts ...InvokeOption) GetRedisClustersResultOutput

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

    public static class GetRedisClusters 
{
    public static Task<GetRedisClustersResult> InvokeAsync(GetRedisClustersArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisClustersResult> Invoke(GetRedisClustersInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRedisClustersResult> getRedisClusters(GetRedisClustersArgs args, InvokeOptions options)
public static Output<GetRedisClustersResult> getRedisClusters(GetRedisClustersArgs args, InvokeOptions options)

    fn::invoke:
  function: tencentcloud:index/getRedisClusters:getRedisClusters
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AutoRenewFlags List<double>
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    ClusterName string
    Cluster name.
    DedicatedClusterId string
    Dedicated cluster Id.
    Id string
    ProjectIds List<double>
    Project Ids.
    RedisClusterIds List<string>
    Redis Cluster Ids.
    ResultOutputFile string
    Used to save results.
    Statuses List<double>
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    AutoRenewFlags []float64
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    ClusterName string
    Cluster name.
    DedicatedClusterId string
    Dedicated cluster Id.
    Id string
    ProjectIds []float64
    Project Ids.
    RedisClusterIds []string
    Redis Cluster Ids.
    ResultOutputFile string
    Used to save results.
    Statuses []float64
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    autoRenewFlags List<Double>
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    clusterName String
    Cluster name.
    dedicatedClusterId String
    Dedicated cluster Id.
    id String
    projectIds List<Double>
    Project Ids.
    redisClusterIds List<String>
    Redis Cluster Ids.
    resultOutputFile String
    Used to save results.
    statuses List<Double>
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    autoRenewFlags number[]
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    clusterName string
    Cluster name.
    dedicatedClusterId string
    Dedicated cluster Id.
    id string
    projectIds number[]
    Project Ids.
    redisClusterIds string[]
    Redis Cluster Ids.
    resultOutputFile string
    Used to save results.
    statuses number[]
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    auto_renew_flags Sequence[float]
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    cluster_name str
    Cluster name.
    dedicated_cluster_id str
    Dedicated cluster Id.
    id str
    project_ids Sequence[float]
    Project Ids.
    redis_cluster_ids Sequence[str]
    Redis Cluster Ids.
    result_output_file str
    Used to save results.
    statuses Sequence[float]
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    autoRenewFlags List<Number>
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    clusterName String
    Cluster name.
    dedicatedClusterId String
    Dedicated cluster Id.
    id String
    projectIds List<Number>
    Project Ids.
    redisClusterIds List<String>
    Redis Cluster Ids.
    resultOutputFile String
    Used to save results.
    statuses List<Number>
    Cluster status: 1- In process, 2- Running, 3- Isolated.

    getRedisClusters Result

    The following output properties are available:

    Id string
    Resources List<GetRedisClustersResource>
    .
    AutoRenewFlags List<double>
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    ClusterName string
    Cluster name.
    DedicatedClusterId string
    Dedicated cluster Id.
    ProjectIds List<double>
    RedisClusterIds List<string>
    ResultOutputFile string
    Statuses List<double>
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    Id string
    Resources []GetRedisClustersResource
    .
    AutoRenewFlags []float64
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    ClusterName string
    Cluster name.
    DedicatedClusterId string
    Dedicated cluster Id.
    ProjectIds []float64
    RedisClusterIds []string
    ResultOutputFile string
    Statuses []float64
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    id String
    resources List<GetRedisClustersResource>
    .
    autoRenewFlags List<Double>
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    clusterName String
    Cluster name.
    dedicatedClusterId String
    Dedicated cluster Id.
    projectIds List<Double>
    redisClusterIds List<String>
    resultOutputFile String
    statuses List<Double>
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    id string
    resources GetRedisClustersResource[]
    .
    autoRenewFlags number[]
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    clusterName string
    Cluster name.
    dedicatedClusterId string
    Dedicated cluster Id.
    projectIds number[]
    redisClusterIds string[]
    resultOutputFile string
    statuses number[]
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    id str
    resources Sequence[GetRedisClustersResource]
    .
    auto_renew_flags Sequence[float]
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    cluster_name str
    Cluster name.
    dedicated_cluster_id str
    Dedicated cluster Id.
    project_ids Sequence[float]
    redis_cluster_ids Sequence[str]
    result_output_file str
    statuses Sequence[float]
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    id String
    resources List<Property Map>
    .
    autoRenewFlags List<Number>
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    clusterName String
    Cluster name.
    dedicatedClusterId String
    Dedicated cluster Id.
    projectIds List<Number>
    redisClusterIds List<String>
    resultOutputFile String
    statuses List<Number>
    Cluster status: 1- In process, 2- Running, 3- Isolated.

    Supporting Types

    GetRedisClustersResource

    AppId double
    User's Appid.
    AutoRenewFlag double
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    BaseBundles List<GetRedisClustersResourceBaseBundle>
    Basic Control Resource Package.
    ClusterName string
    Cluster name.
    DedicatedClusterId string
    Dedicated cluster Id.
    EndTime string
    Instance expiration time.
    PayMode double
    Billing mode, 1-annual and monthly package, 0-quantity based billing.
    ProjectId double
    Project Id.
    RedisClusterId string
    Redis Cluster Id.
    RegionId double
    Region Id.
    ResourceBundles List<GetRedisClustersResourceResourceBundle>
    List of Resource Packages.
    StartTime string
    Instance create time.
    Status double
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    ZoneId double
    zone Id.
    AppId float64
    User's Appid.
    AutoRenewFlag float64
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    BaseBundles []GetRedisClustersResourceBaseBundle
    Basic Control Resource Package.
    ClusterName string
    Cluster name.
    DedicatedClusterId string
    Dedicated cluster Id.
    EndTime string
    Instance expiration time.
    PayMode float64
    Billing mode, 1-annual and monthly package, 0-quantity based billing.
    ProjectId float64
    Project Id.
    RedisClusterId string
    Redis Cluster Id.
    RegionId float64
    Region Id.
    ResourceBundles []GetRedisClustersResourceResourceBundle
    List of Resource Packages.
    StartTime string
    Instance create time.
    Status float64
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    ZoneId float64
    zone Id.
    appId Double
    User's Appid.
    autoRenewFlag Double
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    baseBundles List<GetRedisClustersResourceBaseBundle>
    Basic Control Resource Package.
    clusterName String
    Cluster name.
    dedicatedClusterId String
    Dedicated cluster Id.
    endTime String
    Instance expiration time.
    payMode Double
    Billing mode, 1-annual and monthly package, 0-quantity based billing.
    projectId Double
    Project Id.
    redisClusterId String
    Redis Cluster Id.
    regionId Double
    Region Id.
    resourceBundles List<GetRedisClustersResourceResourceBundle>
    List of Resource Packages.
    startTime String
    Instance create time.
    status Double
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    zoneId Double
    zone Id.
    appId number
    User's Appid.
    autoRenewFlag number
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    baseBundles GetRedisClustersResourceBaseBundle[]
    Basic Control Resource Package.
    clusterName string
    Cluster name.
    dedicatedClusterId string
    Dedicated cluster Id.
    endTime string
    Instance expiration time.
    payMode number
    Billing mode, 1-annual and monthly package, 0-quantity based billing.
    projectId number
    Project Id.
    redisClusterId string
    Redis Cluster Id.
    regionId number
    Region Id.
    resourceBundles GetRedisClustersResourceResourceBundle[]
    List of Resource Packages.
    startTime string
    Instance create time.
    status number
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    zoneId number
    zone Id.
    app_id float
    User's Appid.
    auto_renew_flag float
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    base_bundles Sequence[GetRedisClustersResourceBaseBundle]
    Basic Control Resource Package.
    cluster_name str
    Cluster name.
    dedicated_cluster_id str
    Dedicated cluster Id.
    end_time str
    Instance expiration time.
    pay_mode float
    Billing mode, 1-annual and monthly package, 0-quantity based billing.
    project_id float
    Project Id.
    redis_cluster_id str
    Redis Cluster Id.
    region_id float
    Region Id.
    resource_bundles Sequence[GetRedisClustersResourceResourceBundle]
    List of Resource Packages.
    start_time str
    Instance create time.
    status float
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    zone_id float
    zone Id.
    appId Number
    User's Appid.
    autoRenewFlag Number
    Renewal mode: 0- default state (manual renewal); 1- Automatic renewal; 2- Clearly stating that automatic renewal is not allowed.
    baseBundles List<Property Map>
    Basic Control Resource Package.
    clusterName String
    Cluster name.
    dedicatedClusterId String
    Dedicated cluster Id.
    endTime String
    Instance expiration time.
    payMode Number
    Billing mode, 1-annual and monthly package, 0-quantity based billing.
    projectId Number
    Project Id.
    redisClusterId String
    Redis Cluster Id.
    regionId Number
    Region Id.
    resourceBundles List<Property Map>
    List of Resource Packages.
    startTime String
    Instance create time.
    status Number
    Cluster status: 1- In process, 2- Running, 3- Isolated.
    zoneId Number
    zone Id.

    GetRedisClustersResourceBaseBundle

    AvailableMemory double
    Saleable memory, unit: GB.
    Count double
    Resource bundle count.
    ResourceBundleName string
    Resource bundle name.
    AvailableMemory float64
    Saleable memory, unit: GB.
    Count float64
    Resource bundle count.
    ResourceBundleName string
    Resource bundle name.
    availableMemory Double
    Saleable memory, unit: GB.
    count Double
    Resource bundle count.
    resourceBundleName String
    Resource bundle name.
    availableMemory number
    Saleable memory, unit: GB.
    count number
    Resource bundle count.
    resourceBundleName string
    Resource bundle name.
    available_memory float
    Saleable memory, unit: GB.
    count float
    Resource bundle count.
    resource_bundle_name str
    Resource bundle name.
    availableMemory Number
    Saleable memory, unit: GB.
    count Number
    Resource bundle count.
    resourceBundleName String
    Resource bundle name.

    GetRedisClustersResourceResourceBundle

    AvailableMemory double
    Saleable memory, unit: GB.
    Count double
    Resource bundle count.
    ResourceBundleName string
    Resource bundle name.
    AvailableMemory float64
    Saleable memory, unit: GB.
    Count float64
    Resource bundle count.
    ResourceBundleName string
    Resource bundle name.
    availableMemory Double
    Saleable memory, unit: GB.
    count Double
    Resource bundle count.
    resourceBundleName String
    Resource bundle name.
    availableMemory number
    Saleable memory, unit: GB.
    count number
    Resource bundle count.
    resourceBundleName string
    Resource bundle name.
    available_memory float
    Saleable memory, unit: GB.
    count float
    Resource bundle count.
    resource_bundle_name str
    Resource bundle name.
    availableMemory Number
    Saleable memory, unit: GB.
    count Number
    Resource bundle count.
    resourceBundleName String
    Resource bundle name.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud