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.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getRedisClusters

Explore with Pulumi AI

tencentcloud 1.81.183 published on Wednesday, Apr 16, 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({});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

clusters = tencentcloud.get_redis_clusters()
Copy
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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

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

});
Copy
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();

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

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,
    ],
});
Copy
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,
    ])
Copy
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
	})
}
Copy
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,
        },
    });

});
Copy
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());

    }
}
Copy
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
Copy

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>
Copy
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]
Copy
func GetRedisClusters(ctx *Context, args *GetRedisClustersArgs, opts ...InvokeOption) (*GetRedisClustersResult, error)
func GetRedisClustersOutput(ctx *Context, args *GetRedisClustersOutputArgs, opts ...InvokeOption) GetRedisClustersResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetRedisClustersResult> getRedisClusters(GetRedisClustersArgs args, InvokeOptions options)
public static Output<GetRedisClustersResult> getRedisClusters(GetRedisClustersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: tencentcloud:index/getRedisClusters:getRedisClusters
  arguments:
    # arguments dictionary
Copy

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

GetRedisClustersResourceBaseBundle

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

GetRedisClustersResourceResourceBundle

AvailableMemory This property is required. double
Saleable memory, unit: GB.
Count This property is required. double
Resource bundle count.
ResourceBundleName This property is required. string
Resource bundle name.
AvailableMemory This property is required. float64
Saleable memory, unit: GB.
Count This property is required. float64
Resource bundle count.
ResourceBundleName This property is required. string
Resource bundle name.
availableMemory This property is required. Double
Saleable memory, unit: GB.
count This property is required. Double
Resource bundle count.
resourceBundleName This property is required. String
Resource bundle name.
availableMemory This property is required. number
Saleable memory, unit: GB.
count This property is required. number
Resource bundle count.
resourceBundleName This property is required. string
Resource bundle name.
available_memory This property is required. float
Saleable memory, unit: GB.
count This property is required. float
Resource bundle count.
resource_bundle_name This property is required. str
Resource bundle name.
availableMemory This property is required. Number
Saleable memory, unit: GB.
count This property is required. Number
Resource bundle count.
resourceBundleName This property is required. 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 1.81.183 published on Wednesday, Apr 16, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud