1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Redis
  5. getRedisClusterNodes
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.Redis.getRedisClusterNodes

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

This data source provides the list of Redis Cluster Nodes in Oracle Cloud Infrastructure Redis service.

Gets the list of all nodes in a cluster.

Example Usage

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

const testRedisClusterNodes = oci.Redis.getRedisClusterNodes({
    redisClusterId: testRedisCluster.id,
    displayName: redisClusterNodeDisplayName,
});
Copy
import pulumi
import pulumi_oci as oci

test_redis_cluster_nodes = oci.Redis.get_redis_cluster_nodes(redis_cluster_id=test_redis_cluster["id"],
    display_name=redis_cluster_node_display_name)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redis.GetRedisClusterNodes(ctx, &redis.GetRedisClusterNodesArgs{
			RedisClusterId: testRedisCluster.Id,
			DisplayName:    pulumi.StringRef(redisClusterNodeDisplayName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testRedisClusterNodes = Oci.Redis.GetRedisClusterNodes.Invoke(new()
    {
        RedisClusterId = testRedisCluster.Id,
        DisplayName = redisClusterNodeDisplayName,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Redis.RedisFunctions;
import com.pulumi.oci.Redis.inputs.GetRedisClusterNodesArgs;
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 testRedisClusterNodes = RedisFunctions.getRedisClusterNodes(GetRedisClusterNodesArgs.builder()
            .redisClusterId(testRedisCluster.id())
            .displayName(redisClusterNodeDisplayName)
            .build());

    }
}
Copy
variables:
  testRedisClusterNodes:
    fn::invoke:
      function: oci:Redis:getRedisClusterNodes
      arguments:
        redisClusterId: ${testRedisCluster.id}
        displayName: ${redisClusterNodeDisplayName}
Copy

Using getRedisClusterNodes

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 getRedisClusterNodes(args: GetRedisClusterNodesArgs, opts?: InvokeOptions): Promise<GetRedisClusterNodesResult>
function getRedisClusterNodesOutput(args: GetRedisClusterNodesOutputArgs, opts?: InvokeOptions): Output<GetRedisClusterNodesResult>
Copy
def get_redis_cluster_nodes(display_name: Optional[str] = None,
                            filters: Optional[Sequence[_redis.GetRedisClusterNodesFilter]] = None,
                            redis_cluster_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetRedisClusterNodesResult
def get_redis_cluster_nodes_output(display_name: Optional[pulumi.Input[str]] = None,
                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[_redis.GetRedisClusterNodesFilterArgs]]]] = None,
                            redis_cluster_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetRedisClusterNodesResult]
Copy
func GetRedisClusterNodes(ctx *Context, args *GetRedisClusterNodesArgs, opts ...InvokeOption) (*GetRedisClusterNodesResult, error)
func GetRedisClusterNodesOutput(ctx *Context, args *GetRedisClusterNodesOutputArgs, opts ...InvokeOption) GetRedisClusterNodesResultOutput
Copy

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

public static class GetRedisClusterNodes 
{
    public static Task<GetRedisClusterNodesResult> InvokeAsync(GetRedisClusterNodesArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisClusterNodesResult> Invoke(GetRedisClusterNodesInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetRedisClusterNodesResult> getRedisClusterNodes(GetRedisClusterNodesArgs args, InvokeOptions options)
public static Output<GetRedisClusterNodesResult> getRedisClusterNodes(GetRedisClusterNodesArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:Redis/getRedisClusterNodes:getRedisClusterNodes
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

RedisClusterId This property is required. string
The OCID of the cluster.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. List<GetRedisClusterNodesFilter>
RedisClusterId This property is required. string
The OCID of the cluster.
DisplayName string
A filter to return only resources that match the entire display name given.
Filters Changes to this property will trigger replacement. []GetRedisClusterNodesFilter
redisClusterId This property is required. String
The OCID of the cluster.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<GetClusterNodesFilter>
redisClusterId This property is required. string
The OCID of the cluster.
displayName string
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. GetRedisClusterNodesFilter[]
redis_cluster_id This property is required. str
The OCID of the cluster.
display_name str
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. Sequence[redis.GetRedisClusterNodesFilter]
redisClusterId This property is required. String
The OCID of the cluster.
displayName String
A filter to return only resources that match the entire display name given.
filters Changes to this property will trigger replacement. List<Property Map>

getRedisClusterNodes Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
RedisClusterId string
The OCID of the cluster
RedisNodeCollections List<GetRedisClusterNodesRedisNodeCollection>
The list of redis_node_collection.
DisplayName string
A user-friendly name of a cluster node.
Filters List<GetRedisClusterNodesFilter>
Id string
The provider-assigned unique ID for this managed resource.
RedisClusterId string
The OCID of the cluster
RedisNodeCollections []GetRedisClusterNodesRedisNodeCollection
The list of redis_node_collection.
DisplayName string
A user-friendly name of a cluster node.
Filters []GetRedisClusterNodesFilter
id String
The provider-assigned unique ID for this managed resource.
redisClusterId String
The OCID of the cluster
redisNodeCollections List<GetClusterNodesNodeCollection>
The list of redis_node_collection.
displayName String
A user-friendly name of a cluster node.
filters List<GetClusterNodesFilter>
id string
The provider-assigned unique ID for this managed resource.
redisClusterId string
The OCID of the cluster
redisNodeCollections GetRedisClusterNodesRedisNodeCollection[]
The list of redis_node_collection.
displayName string
A user-friendly name of a cluster node.
filters GetRedisClusterNodesFilter[]
id str
The provider-assigned unique ID for this managed resource.
redis_cluster_id str
The OCID of the cluster
redis_node_collections Sequence[redis.GetRedisClusterNodesRedisNodeCollection]
The list of redis_node_collection.
display_name str
A user-friendly name of a cluster node.
filters Sequence[redis.GetRedisClusterNodesFilter]
id String
The provider-assigned unique ID for this managed resource.
redisClusterId String
The OCID of the cluster
redisNodeCollections List<Property Map>
The list of redis_node_collection.
displayName String
A user-friendly name of a cluster node.
filters List<Property Map>

Supporting Types

GetRedisClusterNodesFilter

Name This property is required. string
Values This property is required. List<string>
Regex bool
Name This property is required. string
Values This property is required. []string
Regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean
name This property is required. string
values This property is required. string[]
regex boolean
name This property is required. str
values This property is required. Sequence[str]
regex bool
name This property is required. String
values This property is required. List<String>
regex Boolean

GetRedisClusterNodesRedisNodeCollection

Items This property is required. List<GetRedisClusterNodesRedisNodeCollectionItem>
The list of nodes in a cluster.
Items This property is required. []GetRedisClusterNodesRedisNodeCollectionItem
The list of nodes in a cluster.
items This property is required. List<GetClusterNodesNodeCollectionItem>
The list of nodes in a cluster.
items This property is required. GetRedisClusterNodesRedisNodeCollectionItem[]
The list of nodes in a cluster.
items This property is required. Sequence[redis.GetRedisClusterNodesRedisNodeCollectionItem]
The list of nodes in a cluster.
items This property is required. List<Property Map>
The list of nodes in a cluster.

GetRedisClusterNodesRedisNodeCollectionItem

DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
PrivateEndpointFqdn This property is required. string
The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
PrivateEndpointIpAddress This property is required. string
The private IP address of the API endpoint to access a specific node.
RedisClusterId This property is required. string
The OCID of the cluster.
ShardNumber This property is required. int
The shard number to which the node belongs to.
DisplayName This property is required. string
A filter to return only resources that match the entire display name given.
PrivateEndpointFqdn This property is required. string
The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
PrivateEndpointIpAddress This property is required. string
The private IP address of the API endpoint to access a specific node.
RedisClusterId This property is required. string
The OCID of the cluster.
ShardNumber This property is required. int
The shard number to which the node belongs to.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
privateEndpointFqdn This property is required. String
The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
privateEndpointIpAddress This property is required. String
The private IP address of the API endpoint to access a specific node.
redisClusterId This property is required. String
The OCID of the cluster.
shardNumber This property is required. Integer
The shard number to which the node belongs to.
displayName This property is required. string
A filter to return only resources that match the entire display name given.
privateEndpointFqdn This property is required. string
The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
privateEndpointIpAddress This property is required. string
The private IP address of the API endpoint to access a specific node.
redisClusterId This property is required. string
The OCID of the cluster.
shardNumber This property is required. number
The shard number to which the node belongs to.
display_name This property is required. str
A filter to return only resources that match the entire display name given.
private_endpoint_fqdn This property is required. str
The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
private_endpoint_ip_address This property is required. str
The private IP address of the API endpoint to access a specific node.
redis_cluster_id This property is required. str
The OCID of the cluster.
shard_number This property is required. int
The shard number to which the node belongs to.
displayName This property is required. String
A filter to return only resources that match the entire display name given.
privateEndpointFqdn This property is required. String
The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
privateEndpointIpAddress This property is required. String
The private IP address of the API endpoint to access a specific node.
redisClusterId This property is required. String
The OCID of the cluster.
shardNumber This property is required. Number
The shard number to which the node belongs to.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi