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

oci.Redis.getRedisCluster

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Redis Cluster resource in Oracle Cloud Infrastructure Redis service.

    Retrieves the specified Oracle Cloud Infrastructure Cache cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache.

    Example Usage

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

const testRedisCluster = oci.Redis.getRedisCluster({
    redisClusterId: testRedisClusterOciRedisRedisCluster.id,
});

    import pulumi
import pulumi_oci as oci

test_redis_cluster = oci.Redis.get_redis_cluster(redis_cluster_id=test_redis_cluster_oci_redis_redis_cluster["id"])

    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.GetRedisCluster(ctx, &redis.GetRedisClusterArgs{
			RedisClusterId: testRedisClusterOciRedisRedisCluster.Id,
		}, 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 testRedisCluster = Oci.Redis.GetRedisCluster.Invoke(new()
    {
        RedisClusterId = testRedisClusterOciRedisRedisCluster.Id,
    });

});

    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.GetRedisClusterArgs;
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 testRedisCluster = RedisFunctions.getRedisCluster(GetRedisClusterArgs.builder()
            .redisClusterId(testRedisClusterOciRedisRedisCluster.id())
            .build());

    }
}

    variables:
  testRedisCluster:
    fn::invoke:
      function: oci:Redis:getRedisCluster
      arguments:
        redisClusterId: ${testRedisClusterOciRedisRedisCluster.id}

    Using getRedisCluster

    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 getRedisCluster(args: GetRedisClusterArgs, opts?: InvokeOptions): Promise<GetRedisClusterResult>
function getRedisClusterOutput(args: GetRedisClusterOutputArgs, opts?: InvokeOptions): Output<GetRedisClusterResult>
    def get_redis_cluster(redis_cluster_id: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetRedisClusterResult
def get_redis_cluster_output(redis_cluster_id: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetRedisClusterResult]
    func GetRedisCluster(ctx *Context, args *GetRedisClusterArgs, opts ...InvokeOption) (*GetRedisClusterResult, error)
func GetRedisClusterOutput(ctx *Context, args *GetRedisClusterOutputArgs, opts ...InvokeOption) GetRedisClusterResultOutput

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

    public static class GetRedisCluster 
{
    public static Task<GetRedisClusterResult> InvokeAsync(GetRedisClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetRedisClusterResult> Invoke(GetRedisClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRedisClusterResult> getRedisCluster(GetRedisClusterArgs args, InvokeOptions options)
public static Output<GetRedisClusterResult> getRedisCluster(GetRedisClusterArgs args, InvokeOptions options)

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

    The following arguments are supported:

    RedisClusterId string
    The OCID of the cluster.
    RedisClusterId string
    The OCID of the cluster.
    redisClusterId String
    The OCID of the cluster.
    redisClusterId string
    The OCID of the cluster.
    redis_cluster_id str
    The OCID of the cluster.
    redisClusterId String
    The OCID of the cluster.

    getRedisCluster Result

    The following output properties are available:

    ClusterMode string
    Specifies whether the cluster is sharded or non-sharded.
    CompartmentId string
    The OCID of the compartment that contains the cluster.
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name of a cluster node.
    FreeformTags Dictionary<string, string>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the cluster.
    LifecycleDetails string
    A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
    NodeCollections List<GetRedisClusterNodeCollection>
    The collection of cluster nodes.
    NodeCount int
    The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
    NodeMemoryInGbs double
    The amount of memory allocated to the cluster's nodes, in gigabytes.
    NsgIds List<string>
    A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    PrimaryEndpointIpAddress string
    The private IP address of the API endpoint for the cluster's primary node.
    PrimaryFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
    RedisClusterId string
    ReplicasEndpointIpAddress string
    The private IP address of the API endpoint for the cluster's replica nodes.
    ReplicasFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
    ShardCount int
    The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
    SoftwareVersion string
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    State string
    The current state of the cluster.
    SubnetId string
    The OCID of the cluster's subnet.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cluster was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The date and time the cluster was updated. An RFC3339 formatted datetime string.
    ClusterMode string
    Specifies whether the cluster is sharded or non-sharded.
    CompartmentId string
    The OCID of the compartment that contains the cluster.
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A user-friendly name of a cluster node.
    FreeformTags map[string]string
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    Id string
    The OCID of the cluster.
    LifecycleDetails string
    A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
    NodeCollections []GetRedisClusterNodeCollection
    The collection of cluster nodes.
    NodeCount int
    The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
    NodeMemoryInGbs float64
    The amount of memory allocated to the cluster's nodes, in gigabytes.
    NsgIds []string
    A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    PrimaryEndpointIpAddress string
    The private IP address of the API endpoint for the cluster's primary node.
    PrimaryFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
    RedisClusterId string
    ReplicasEndpointIpAddress string
    The private IP address of the API endpoint for the cluster's replica nodes.
    ReplicasFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
    ShardCount int
    The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
    SoftwareVersion string
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    State string
    The current state of the cluster.
    SubnetId string
    The OCID of the cluster's subnet.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time the cluster was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The date and time the cluster was updated. An RFC3339 formatted datetime string.
    clusterMode String
    Specifies whether the cluster is sharded or non-sharded.
    compartmentId String
    The OCID of the compartment that contains the cluster.
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name of a cluster node.
    freeformTags Map<String,String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the cluster.
    lifecycleDetails String
    A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
    nodeCollections List<GetClusterNodeCollection>
    The collection of cluster nodes.
    nodeCount Integer
    The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
    nodeMemoryInGbs Double
    The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsgIds List<String>
    A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    primaryEndpointIpAddress String
    The private IP address of the API endpoint for the cluster's primary node.
    primaryFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
    redisClusterId String
    replicasEndpointIpAddress String
    The private IP address of the API endpoint for the cluster's replica nodes.
    replicasFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
    shardCount Integer
    The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
    softwareVersion String
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    state String
    The current state of the cluster.
    subnetId String
    The OCID of the cluster's subnet.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cluster was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The date and time the cluster was updated. An RFC3339 formatted datetime string.
    clusterMode string
    Specifies whether the cluster is sharded or non-sharded.
    compartmentId string
    The OCID of the compartment that contains the cluster.
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A user-friendly name of a cluster node.
    freeformTags {[key: string]: string}
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id string
    The OCID of the cluster.
    lifecycleDetails string
    A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
    nodeCollections GetRedisClusterNodeCollection[]
    The collection of cluster nodes.
    nodeCount number
    The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
    nodeMemoryInGbs number
    The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsgIds string[]
    A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    primaryEndpointIpAddress string
    The private IP address of the API endpoint for the cluster's primary node.
    primaryFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
    redisClusterId string
    replicasEndpointIpAddress string
    The private IP address of the API endpoint for the cluster's replica nodes.
    replicasFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
    shardCount number
    The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
    softwareVersion string
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    state string
    The current state of the cluster.
    subnetId string
    The OCID of the cluster's subnet.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time the cluster was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The date and time the cluster was updated. An RFC3339 formatted datetime string.
    cluster_mode str
    Specifies whether the cluster is sharded or non-sharded.
    compartment_id str
    The OCID of the compartment that contains the cluster.
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    A user-friendly name of a cluster node.
    freeform_tags Mapping[str, str]
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id str
    The OCID of the cluster.
    lifecycle_details str
    A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
    node_collections Sequence[redis.GetRedisClusterNodeCollection]
    The collection of cluster nodes.
    node_count int
    The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
    node_memory_in_gbs float
    The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsg_ids Sequence[str]
    A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    primary_endpoint_ip_address str
    The private IP address of the API endpoint for the cluster's primary node.
    primary_fqdn str
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
    redis_cluster_id str
    replicas_endpoint_ip_address str
    The private IP address of the API endpoint for the cluster's replica nodes.
    replicas_fqdn str
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
    shard_count int
    The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
    software_version str
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    state str
    The current state of the cluster.
    subnet_id str
    The OCID of the cluster's subnet.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time the cluster was created. An RFC3339 formatted datetime string.
    time_updated str
    The date and time the cluster was updated. An RFC3339 formatted datetime string.
    clusterMode String
    Specifies whether the cluster is sharded or non-sharded.
    compartmentId String
    The OCID of the compartment that contains the cluster.
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A user-friendly name of a cluster node.
    freeformTags Map<String>
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    id String
    The OCID of the cluster.
    lifecycleDetails String
    A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
    nodeCollections List<Property Map>
    The collection of cluster nodes.
    nodeCount Number
    The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.
    nodeMemoryInGbs Number
    The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsgIds List<String>
    A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    primaryEndpointIpAddress String
    The private IP address of the API endpoint for the cluster's primary node.
    primaryFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's primary node.
    redisClusterId String
    replicasEndpointIpAddress String
    The private IP address of the API endpoint for the cluster's replica nodes.
    replicasFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the cluster's replica nodes.
    shardCount Number
    The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
    softwareVersion String
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    state String
    The current state of the cluster.
    subnetId String
    The OCID of the cluster's subnet.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time the cluster was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The date and time the cluster was updated. An RFC3339 formatted datetime string.

    Supporting Types

    GetRedisClusterNodeCollection

    Items []GetRedisClusterNodeCollectionItem
    Collection of node objects.
    items List<GetClusterNodeCollectionItem>
    Collection of node objects.
    items GetRedisClusterNodeCollectionItem[]
    Collection of node objects.
    items List<Property Map>
    Collection of node objects.

    GetRedisClusterNodeCollectionItem

    DisplayName string
    A user-friendly name of a cluster node.
    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.
    DisplayName string
    A user-friendly name of a cluster node.
    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.
    displayName String
    A user-friendly name of a cluster node.
    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.
    displayName string
    A user-friendly name of a cluster node.
    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.
    display_name str
    A user-friendly name of a cluster node.
    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.
    displayName String
    A user-friendly name of a cluster node.
    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.

    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.31.0 published on Thursday, Apr 17, 2025 by Pulumi
    pulumi/pulumi-oci