Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Redis
  5. RedisClusterGetOciCacheUser
Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi
pulumi/pulumi-oci

oci.Redis.RedisClusterGetOciCacheUser

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v3.3.0 published on Thursday, Jul 17, 2025 by Pulumi
pulumi/pulumi-oci

    This resource provides the Redis Cluster Get Oci Cache User resource in Oracle Cloud Infrastructure Redis service.

    Gets a list of associated Oracle Cloud Infrastructure cache users for a redis cluster.

    Example Usage

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

const testRedisClusterGetOciCacheUser = new oci.redis.RedisClusterGetOciCacheUser("test_redis_cluster_get_oci_cache_user", {
    redisClusterId: testRedisCluster.id,
    compartmentId: compartmentId,
    displayName: redisClusterGetOciCacheUserDisplayName,
});

    import pulumi
import pulumi_oci as oci

test_redis_cluster_get_oci_cache_user = oci.redis.RedisClusterGetOciCacheUser("test_redis_cluster_get_oci_cache_user",
    redis_cluster_id=test_redis_cluster["id"],
    compartment_id=compartment_id,
    display_name=redis_cluster_get_oci_cache_user_display_name)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redis.NewRedisClusterGetOciCacheUser(ctx, "test_redis_cluster_get_oci_cache_user", &redis.RedisClusterGetOciCacheUserArgs{
			RedisClusterId: pulumi.Any(testRedisCluster.Id),
			CompartmentId:  pulumi.Any(compartmentId),
			DisplayName:    pulumi.Any(redisClusterGetOciCacheUserDisplayName),
		})
		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 testRedisClusterGetOciCacheUser = new Oci.Redis.RedisClusterGetOciCacheUser("test_redis_cluster_get_oci_cache_user", new()
    {
        RedisClusterId = testRedisCluster.Id,
        CompartmentId = compartmentId,
        DisplayName = redisClusterGetOciCacheUserDisplayName,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Redis.RedisClusterGetOciCacheUser;
import com.pulumi.oci.Redis.RedisClusterGetOciCacheUserArgs;
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) {
        var testRedisClusterGetOciCacheUser = new RedisClusterGetOciCacheUser("testRedisClusterGetOciCacheUser", RedisClusterGetOciCacheUserArgs.builder()
            .redisClusterId(testRedisCluster.id())
            .compartmentId(compartmentId)
            .displayName(redisClusterGetOciCacheUserDisplayName)
            .build());

    }
}

    resources:
  testRedisClusterGetOciCacheUser:
    type: oci:Redis:RedisClusterGetOciCacheUser
    name: test_redis_cluster_get_oci_cache_user
    properties:
      redisClusterId: ${testRedisCluster.id}
      compartmentId: ${compartmentId}
      displayName: ${redisClusterGetOciCacheUserDisplayName}

    Create RedisClusterGetOciCacheUser Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new RedisClusterGetOciCacheUser(name: string, args: RedisClusterGetOciCacheUserArgs, opts?: CustomResourceOptions);
    @overload
def RedisClusterGetOciCacheUser(resource_name: str,
                                args: RedisClusterGetOciCacheUserArgs,
                                opts: Optional[ResourceOptions] = None)

@overload
def RedisClusterGetOciCacheUser(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                redis_cluster_id: Optional[str] = None,
                                compartment_id: Optional[str] = None,
                                display_name: Optional[str] = None)
    func NewRedisClusterGetOciCacheUser(ctx *Context, name string, args RedisClusterGetOciCacheUserArgs, opts ...ResourceOption) (*RedisClusterGetOciCacheUser, error)
    public RedisClusterGetOciCacheUser(string name, RedisClusterGetOciCacheUserArgs args, CustomResourceOptions? opts = null)
    public RedisClusterGetOciCacheUser(String name, RedisClusterGetOciCacheUserArgs args)
public RedisClusterGetOciCacheUser(String name, RedisClusterGetOciCacheUserArgs args, CustomResourceOptions options)

    type: oci:Redis:RedisClusterGetOciCacheUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args RedisClusterGetOciCacheUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args RedisClusterGetOciCacheUserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args RedisClusterGetOciCacheUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RedisClusterGetOciCacheUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RedisClusterGetOciCacheUserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var redisClusterGetOciCacheUserResource = new Oci.Redis.RedisClusterGetOciCacheUser("redisClusterGetOciCacheUserResource", new()
{
    RedisClusterId = "string",
    CompartmentId = "string",
    DisplayName = "string",
});

    example, err := redis.NewRedisClusterGetOciCacheUser(ctx, "redisClusterGetOciCacheUserResource", &redis.RedisClusterGetOciCacheUserArgs{
	RedisClusterId: pulumi.String("string"),
	CompartmentId:  pulumi.String("string"),
	DisplayName:    pulumi.String("string"),
})

    var redisClusterGetOciCacheUserResource = new RedisClusterGetOciCacheUser("redisClusterGetOciCacheUserResource", RedisClusterGetOciCacheUserArgs.builder()
    .redisClusterId("string")
    .compartmentId("string")
    .displayName("string")
    .build());

    redis_cluster_get_oci_cache_user_resource = oci.redis.RedisClusterGetOciCacheUser("redisClusterGetOciCacheUserResource",
    redis_cluster_id="string",
    compartment_id="string",
    display_name="string")

    const redisClusterGetOciCacheUserResource = new oci.redis.RedisClusterGetOciCacheUser("redisClusterGetOciCacheUserResource", {
    redisClusterId: "string",
    compartmentId: "string",
    displayName: "string",
});

    type: oci:Redis:RedisClusterGetOciCacheUser
properties:
    compartmentId: string
    displayName: string
    redisClusterId: string

    RedisClusterGetOciCacheUser Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The RedisClusterGetOciCacheUser resource accepts the following input properties:

    RedisClusterId string

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

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

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the RedisClusterGetOciCacheUser resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    OciCacheUsers List<RedisClusterGetOciCacheUserOciCacheUser>
    Id string
    The provider-assigned unique ID for this managed resource.
    OciCacheUsers []RedisClusterGetOciCacheUserOciCacheUser
    id String
    The provider-assigned unique ID for this managed resource.
    ociCacheUsers List<ClusterGetOciCacheUserOciCacheUser>
    id string
    The provider-assigned unique ID for this managed resource.
    ociCacheUsers RedisClusterGetOciCacheUserOciCacheUser[]
    id str
    The provider-assigned unique ID for this managed resource.
    oci_cache_users Sequence[RedisClusterGetOciCacheUserOciCacheUser]
    id String
    The provider-assigned unique ID for this managed resource.
    ociCacheUsers List<Property Map>

    Look up Existing RedisClusterGetOciCacheUser Resource

    Get an existing RedisClusterGetOciCacheUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: RedisClusterGetOciCacheUserState, opts?: CustomResourceOptions): RedisClusterGetOciCacheUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        display_name: Optional[str] = None,
        oci_cache_users: Optional[Sequence[RedisClusterGetOciCacheUserOciCacheUserArgs]] = None,
        redis_cluster_id: Optional[str] = None) -> RedisClusterGetOciCacheUser
    func GetRedisClusterGetOciCacheUser(ctx *Context, name string, id IDInput, state *RedisClusterGetOciCacheUserState, opts ...ResourceOption) (*RedisClusterGetOciCacheUser, error)
    public static RedisClusterGetOciCacheUser Get(string name, Input<string> id, RedisClusterGetOciCacheUserState? state, CustomResourceOptions? opts = null)
    public static RedisClusterGetOciCacheUser get(String name, Output<String> id, RedisClusterGetOciCacheUserState state, CustomResourceOptions options)
    resources:  _:    type: oci:Redis:RedisClusterGetOciCacheUser    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state 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.
    OciCacheUsers List<RedisClusterGetOciCacheUserOciCacheUser>
    RedisClusterId string

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    OciCacheUsers []RedisClusterGetOciCacheUserOciCacheUserArgs
    RedisClusterId string

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    ociCacheUsers List<ClusterGetOciCacheUserOciCacheUser>
    redisClusterId String

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    ociCacheUsers RedisClusterGetOciCacheUserOciCacheUser[]
    redisClusterId string

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    oci_cache_users Sequence[RedisClusterGetOciCacheUserOciCacheUserArgs]
    redis_cluster_id str

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    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.
    ociCacheUsers List<Property Map>
    redisClusterId String

    The OCID of the cluster.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Supporting Types

    RedisClusterGetOciCacheUserOciCacheUser, RedisClusterGetOciCacheUserOciCacheUserArgs

    OciCacheUserId string
    OCID of the OciCacheUser
    OciCacheUserId string
    OCID of the OciCacheUser
    ociCacheUserId String
    OCID of the OciCacheUser
    ociCacheUserId string
    OCID of the OciCacheUser
    oci_cache_user_id str
    OCID of the OciCacheUser
    ociCacheUserId String
    OCID of the OciCacheUser

    Import

    Import is not supported for this resource.

    To learn more about importing existing cloud resources, see Importing resources.

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