Docs Packages
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Redis
  5. getRedisClusters
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

oci.Redis.getRedisClusters

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
pulumi/pulumi-oci

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

    Lists the Redis clusters in the specified compartment. A Redis cluster is a memory-based storage solution. For more information, see OCI Caching Service with Redis.

    Example Usage

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

const testRedisClusters = oci.Redis.getRedisClusters({
    compartmentId: compartmentId,
    displayName: redisClusterDisplayName,
    id: redisClusterId,
    state: redisClusterState,
});

    import pulumi
import pulumi_oci as oci

test_redis_clusters = oci.Redis.get_redis_clusters(compartment_id=compartment_id,
    display_name=redis_cluster_display_name,
    id=redis_cluster_id,
    state=redis_cluster_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Redis.GetRedisClusters(ctx, &redis.GetRedisClustersArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(redisClusterDisplayName),
			Id:            pulumi.StringRef(redisClusterId),
			State:         pulumi.StringRef(redisClusterState),
		}, 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 testRedisClusters = Oci.Redis.GetRedisClusters.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = redisClusterDisplayName,
        Id = redisClusterId,
        State = redisClusterState,
    });

});

    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.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 testRedisClusters = RedisFunctions.getRedisClusters(GetRedisClustersArgs.builder()
            .compartmentId(compartmentId)
            .displayName(redisClusterDisplayName)
            .id(redisClusterId)
            .state(redisClusterState)
            .build());

    }
}

    variables:
  testRedisClusters:
    fn::invoke:
      Function: oci:Redis:getRedisClusters
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${redisClusterDisplayName}
        id: ${redisClusterId}
        state: ${redisClusterState}

    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(compartment_id: Optional[str] = None,
                       display_name: Optional[str] = None,
                       filters: Optional[Sequence[_redis.GetRedisClustersFilter]] = None,
                       id: Optional[str] = None,
                       state: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetRedisClustersResult
def get_redis_clusters_output(compartment_id: Optional[pulumi.Input[str]] = None,
                       display_name: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[_redis.GetRedisClustersFilterArgs]]]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       state: Optional[pulumi.Input[str]] = 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)
// Output-based functions aren't available in Java yet

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

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters List<GetRedisClustersFilter>
    Id string
    The OCID of the Redis cluster.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the entire display name given.
    Filters []GetRedisClustersFilter
    Id string
    The OCID of the Redis cluster.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<GetClustersFilter>
    id String
    The OCID of the Redis cluster.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId string
    The ID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the entire display name given.
    filters GetRedisClustersFilter[]
    id string
    The OCID of the Redis cluster.
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartment_id str
    The ID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the entire display name given.
    filters Sequence[redis.GetRedisClustersFilter]
    id str
    The OCID of the Redis cluster.
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the entire display name given.
    filters List<Property Map>
    id String
    The OCID of the Redis cluster.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.

    getRedisClusters Result

    The following output properties are available:

    RedisClusterCollections List<GetRedisClustersRedisClusterCollection>
    The list of redis_cluster_collection.
    CompartmentId string
    The OCID of the compartment that contains the Redis cluster.
    DisplayName string
    A user-friendly name of a Redis cluster node.
    Filters List<GetRedisClustersFilter>
    Id string
    The OCID of the Redis cluster.
    State string
    The current state of the Redis cluster.
    RedisClusterCollections []GetRedisClustersRedisClusterCollection
    The list of redis_cluster_collection.
    CompartmentId string
    The OCID of the compartment that contains the Redis cluster.
    DisplayName string
    A user-friendly name of a Redis cluster node.
    Filters []GetRedisClustersFilter
    Id string
    The OCID of the Redis cluster.
    State string
    The current state of the Redis cluster.
    redisClusterCollections List<GetClustersClusterCollection>
    The list of redis_cluster_collection.
    compartmentId String
    The OCID of the compartment that contains the Redis cluster.
    displayName String
    A user-friendly name of a Redis cluster node.
    filters List<GetClustersFilter>
    id String
    The OCID of the Redis cluster.
    state String
    The current state of the Redis cluster.
    redisClusterCollections GetRedisClustersRedisClusterCollection[]
    The list of redis_cluster_collection.
    compartmentId string
    The OCID of the compartment that contains the Redis cluster.
    displayName string
    A user-friendly name of a Redis cluster node.
    filters GetRedisClustersFilter[]
    id string
    The OCID of the Redis cluster.
    state string
    The current state of the Redis cluster.
    redis_cluster_collections Sequence[redis.GetRedisClustersRedisClusterCollection]
    The list of redis_cluster_collection.
    compartment_id str
    The OCID of the compartment that contains the Redis cluster.
    display_name str
    A user-friendly name of a Redis cluster node.
    filters Sequence[redis.GetRedisClustersFilter]
    id str
    The OCID of the Redis cluster.
    state str
    The current state of the Redis cluster.
    redisClusterCollections List<Property Map>
    The list of redis_cluster_collection.
    compartmentId String
    The OCID of the compartment that contains the Redis cluster.
    displayName String
    A user-friendly name of a Redis cluster node.
    filters List<Property Map>
    id String
    The OCID of the Redis cluster.
    state String
    The current state of the Redis cluster.

    Supporting Types

    GetRedisClustersFilter

    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

    GetRedisClustersRedisClusterCollection

    items List<Property Map>
    Collection of node objects.

    GetRedisClustersRedisClusterCollectionItem

    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags Dictionary<string, object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A filter to return only resources that match the entire display name given.
    FreeformTags Dictionary<string, object>
    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 Redis 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<GetRedisClustersRedisClusterCollectionItemNodeCollection>
    The collection of Redis cluster nodes.
    NodeCount int
    The number of nodes in the Redis cluster.
    NodeMemoryInGbs double
    The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
    NsgIds List<string>
    OCIDs of the NSGs to control access in the customer network
    PrimaryEndpointIpAddress string
    The private IP address of the API endpoint for the Redis cluster's primary node.
    PrimaryFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
    ReplicasEndpointIpAddress string
    The private IP address of the API endpoint for the Redis cluster's replica nodes.
    ReplicasFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
    SoftwareVersion string
    The Redis version that the cluster is running.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    SubnetId string
    The OCID of the Redis cluster's subnet.
    SystemTags Dictionary<string, object>
    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 Redis cluster was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DefinedTags map[string]interface{}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    A filter to return only resources that match the entire display name given.
    FreeformTags map[string]interface{}
    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 Redis 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 []GetRedisClustersRedisClusterCollectionItemNodeCollection
    The collection of Redis cluster nodes.
    NodeCount int
    The number of nodes in the Redis cluster.
    NodeMemoryInGbs float64
    The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
    NsgIds []string
    OCIDs of the NSGs to control access in the customer network
    PrimaryEndpointIpAddress string
    The private IP address of the API endpoint for the Redis cluster's primary node.
    PrimaryFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
    ReplicasEndpointIpAddress string
    The private IP address of the API endpoint for the Redis cluster's replica nodes.
    ReplicasFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
    SoftwareVersion string
    The Redis version that the cluster is running.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    SubnetId string
    The OCID of the Redis cluster's subnet.
    SystemTags map[string]interface{}
    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 Redis cluster was created. An RFC3339 formatted datetime string.
    TimeUpdated string
    The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.
    compartmentId String
    The ID of the compartment in which to list resources.
    definedTags Map<String,Object>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A filter to return only resources that match the entire display name given.
    freeformTags Map<String,Object>
    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 Redis 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<GetClustersClusterCollectionItemNodeCollection>
    The collection of Redis cluster nodes.
    nodeCount Integer
    The number of nodes in the Redis cluster.
    nodeMemoryInGbs Double
    The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
    nsgIds List<String>
    OCIDs of the NSGs to control access in the customer network
    primaryEndpointIpAddress String
    The private IP address of the API endpoint for the Redis cluster's primary node.
    primaryFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
    replicasEndpointIpAddress String
    The private IP address of the API endpoint for the Redis cluster's replica nodes.
    replicasFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
    softwareVersion String
    The Redis version that the cluster is running.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnetId String
    The OCID of the Redis cluster's subnet.
    systemTags Map<String,Object>
    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 Redis cluster was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.
    compartmentId string
    The ID of the compartment in which to list resources.
    definedTags {[key: string]: any}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    A filter to return only resources that match the entire display name given.
    freeformTags {[key: string]: any}
    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 Redis 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 GetRedisClustersRedisClusterCollectionItemNodeCollection[]
    The collection of Redis cluster nodes.
    nodeCount number
    The number of nodes in the Redis cluster.
    nodeMemoryInGbs number
    The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
    nsgIds string[]
    OCIDs of the NSGs to control access in the customer network
    primaryEndpointIpAddress string
    The private IP address of the API endpoint for the Redis cluster's primary node.
    primaryFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
    replicasEndpointIpAddress string
    The private IP address of the API endpoint for the Redis cluster's replica nodes.
    replicasFqdn string
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
    softwareVersion string
    The Redis version that the cluster is running.
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnetId string
    The OCID of the Redis cluster's subnet.
    systemTags {[key: string]: any}
    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 Redis cluster was created. An RFC3339 formatted datetime string.
    timeUpdated string
    The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.
    compartment_id str
    The ID of the compartment in which to list resources.
    defined_tags Mapping[str, Any]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    A filter to return only resources that match the entire display name given.
    freeform_tags Mapping[str, Any]
    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 Redis 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.GetRedisClustersRedisClusterCollectionItemNodeCollection]
    The collection of Redis cluster nodes.
    node_count int
    The number of nodes in the Redis cluster.
    node_memory_in_gbs float
    The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
    nsg_ids Sequence[str]
    OCIDs of the NSGs to control access in the customer network
    primary_endpoint_ip_address str
    The private IP address of the API endpoint for the Redis cluster's primary node.
    primary_fqdn str
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
    replicas_endpoint_ip_address str
    The private IP address of the API endpoint for the Redis cluster's replica nodes.
    replicas_fqdn str
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
    software_version str
    The Redis version that the cluster is running.
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnet_id str
    The OCID of the Redis cluster's subnet.
    system_tags Mapping[str, Any]
    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 Redis cluster was created. An RFC3339 formatted datetime string.
    time_updated str
    The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.
    compartmentId String
    The ID of the compartment in which to list resources.
    definedTags Map<Any>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    A filter to return only resources that match the entire display name given.
    freeformTags Map<Any>
    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 Redis 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 Redis cluster nodes.
    nodeCount Number
    The number of nodes in the Redis cluster.
    nodeMemoryInGbs Number
    The amount of memory allocated to the Redis cluster's nodes, in gigabytes.
    nsgIds List<String>
    OCIDs of the NSGs to control access in the customer network
    primaryEndpointIpAddress String
    The private IP address of the API endpoint for the Redis cluster's primary node.
    primaryFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.
    replicasEndpointIpAddress String
    The private IP address of the API endpoint for the Redis cluster's replica nodes.
    replicasFqdn String
    The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.
    softwareVersion String
    The Redis version that the cluster is running.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnetId String
    The OCID of the Redis cluster's subnet.
    systemTags Map<Any>
    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 Redis cluster was created. An RFC3339 formatted datetime string.
    timeUpdated String
    The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.

    GetRedisClustersRedisClusterCollectionItemNodeCollection

    items List<Property Map>
    Collection of node objects.

    GetRedisClustersRedisClusterCollectionItemNodeCollectionItem

    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.
    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.
    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.
    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.
    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.
    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.

    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 v1.41.0 published on Wednesday, Jun 19, 2024 by Pulumi
    pulumi/pulumi-oci