Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Redis
  5. getRedisClusterNodes
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.Redis.getRedisClusterNodes

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

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

    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)

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

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

});

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

    }
}

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

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

    > 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)
}
    public static CompletableFuture<GetRedisClusterNodesResult> getRedisClusterNodes(GetRedisClusterNodesArgs args, InvokeOptions options)
public static Output<GetRedisClusterNodesResult> getRedisClusterNodes(GetRedisClusterNodesArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:Redis/getRedisClusterNodes:getRedisClusterNodes
  arguments:
    # arguments dictionary

    The following arguments are supported:

    RedisClusterId string
    The OCID of the cluster.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters List<GetRedisClusterNodesFilter>
    RedisClusterId string
    The OCID of the cluster.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetRedisClusterNodesFilter
    redisClusterId String
    The OCID of the cluster.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<GetClusterNodesFilter>
    redisClusterId string
    The OCID of the cluster.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetRedisClusterNodesFilter[]
    redis_cluster_id str
    The OCID of the cluster.
    display_name str
    A filter to return only resources that match the entire display name given.
    filters Sequence[GetRedisClusterNodesFilter]
    redisClusterId String
    The OCID of the cluster.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters 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[GetRedisClusterNodesRedisNodeCollection]
    The list of redis_node_collection.
    display_name str
    A user-friendly name of a cluster node.
    filters Sequence[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 string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetRedisClusterNodesRedisNodeCollection

    items List<GetClusterNodesNodeCollectionItem>
    The list of nodes in a cluster.
    items List<Property Map>
    The list of nodes in a cluster.

    GetRedisClusterNodesRedisNodeCollectionItem

    DisplayName string
    A filter to return only resources that match the entire display name given.
    PrivateEndpointFqdn string
    The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
    PrivateEndpointIpAddress string
    The private IP address of the API endpoint to access a specific node.
    RedisClusterId string
    The OCID of the cluster.
    ShardNumber int
    The shard number to which the node belongs to.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    PrivateEndpointFqdn string
    The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
    PrivateEndpointIpAddress string
    The private IP address of the API endpoint to access a specific node.
    RedisClusterId string
    The OCID of the cluster.
    ShardNumber int
    The shard number to which the node belongs to.
    displayName String
    A filter to return only resources that match the entire display name given.
    privateEndpointFqdn String
    The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
    privateEndpointIpAddress String
    The private IP address of the API endpoint to access a specific node.
    redisClusterId String
    The OCID of the cluster.
    shardNumber Integer
    The shard number to which the node belongs to.
    displayName string
    A filter to return only resources that match the entire display name given.
    privateEndpointFqdn string
    The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
    privateEndpointIpAddress string
    The private IP address of the API endpoint to access a specific node.
    redisClusterId string
    The OCID of the cluster.
    shardNumber number
    The shard number to which the node belongs to.
    display_name str
    A filter to return only resources that match the entire display name given.
    private_endpoint_fqdn str
    The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
    private_endpoint_ip_address str
    The private IP address of the API endpoint to access a specific node.
    redis_cluster_id str
    The OCID of the cluster.
    shard_number int
    The shard number to which the node belongs to.
    displayName String
    A filter to return only resources that match the entire display name given.
    privateEndpointFqdn String
    The fully qualified domain name (FQDN) of the API endpoint to access a specific node.
    privateEndpointIpAddress String
    The private IP address of the API endpoint to access a specific node.
    redisClusterId String
    The OCID of the cluster.
    shardNumber 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.
    oci logo
    Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci