Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Redis
  5. RedisCluster
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.Redis.RedisCluster

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This resource provides the Redis Cluster resource in Oracle Cloud Infrastructure Redis service.

    Creates a new 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 = new oci.redis.RedisCluster("test_redis_cluster", {
    compartmentId: compartmentId,
    displayName: redisClusterDisplayName,
    nodeCount: redisClusterNodeCount,
    nodeMemoryInGbs: redisClusterNodeMemoryInGbs,
    softwareVersion: redisClusterSoftwareVersion,
    subnetId: testSubnet.id,
    clusterMode: redisClusterClusterMode,
    definedTags: {
        "foo-namespace.bar-key": "value",
    },
    freeformTags: {
        "bar-key": "value",
    },
    nsgIds: redisClusterNsgIds,
    shardCount: redisClusterShardCount,
});

    import pulumi
import pulumi_oci as oci

test_redis_cluster = oci.redis.RedisCluster("test_redis_cluster",
    compartment_id=compartment_id,
    display_name=redis_cluster_display_name,
    node_count=redis_cluster_node_count,
    node_memory_in_gbs=redis_cluster_node_memory_in_gbs,
    software_version=redis_cluster_software_version,
    subnet_id=test_subnet["id"],
    cluster_mode=redis_cluster_cluster_mode,
    defined_tags={
        "foo-namespace.bar-key": "value",
    },
    freeform_tags={
        "bar-key": "value",
    },
    nsg_ids=redis_cluster_nsg_ids,
    shard_count=redis_cluster_shard_count)

    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.NewRedisCluster(ctx, "test_redis_cluster", &Redis.RedisClusterArgs{
			CompartmentId:   pulumi.Any(compartmentId),
			DisplayName:     pulumi.Any(redisClusterDisplayName),
			NodeCount:       pulumi.Any(redisClusterNodeCount),
			NodeMemoryInGbs: pulumi.Any(redisClusterNodeMemoryInGbs),
			SoftwareVersion: pulumi.Any(redisClusterSoftwareVersion),
			SubnetId:        pulumi.Any(testSubnet.Id),
			ClusterMode:     pulumi.Any(redisClusterClusterMode),
			DefinedTags: pulumi.StringMap{
				"foo-namespace.bar-key": pulumi.String("value"),
			},
			FreeformTags: pulumi.StringMap{
				"bar-key": pulumi.String("value"),
			},
			NsgIds:     pulumi.Any(redisClusterNsgIds),
			ShardCount: pulumi.Any(redisClusterShardCount),
		})
		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 = new Oci.Redis.RedisCluster("test_redis_cluster", new()
    {
        CompartmentId = compartmentId,
        DisplayName = redisClusterDisplayName,
        NodeCount = redisClusterNodeCount,
        NodeMemoryInGbs = redisClusterNodeMemoryInGbs,
        SoftwareVersion = redisClusterSoftwareVersion,
        SubnetId = testSubnet.Id,
        ClusterMode = redisClusterClusterMode,
        DefinedTags = 
        {
            { "foo-namespace.bar-key", "value" },
        },
        FreeformTags = 
        {
            { "bar-key", "value" },
        },
        NsgIds = redisClusterNsgIds,
        ShardCount = redisClusterShardCount,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Redis.RedisCluster;
import com.pulumi.oci.Redis.RedisClusterArgs;
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 testRedisCluster = new RedisCluster("testRedisCluster", RedisClusterArgs.builder()
            .compartmentId(compartmentId)
            .displayName(redisClusterDisplayName)
            .nodeCount(redisClusterNodeCount)
            .nodeMemoryInGbs(redisClusterNodeMemoryInGbs)
            .softwareVersion(redisClusterSoftwareVersion)
            .subnetId(testSubnet.id())
            .clusterMode(redisClusterClusterMode)
            .definedTags(Map.of("foo-namespace.bar-key", "value"))
            .freeformTags(Map.of("bar-key", "value"))
            .nsgIds(redisClusterNsgIds)
            .shardCount(redisClusterShardCount)
            .build());

    }
}

    resources:
  testRedisCluster:
    type: oci:Redis:RedisCluster
    name: test_redis_cluster
    properties:
      compartmentId: ${compartmentId}
      displayName: ${redisClusterDisplayName}
      nodeCount: ${redisClusterNodeCount}
      nodeMemoryInGbs: ${redisClusterNodeMemoryInGbs}
      softwareVersion: ${redisClusterSoftwareVersion}
      subnetId: ${testSubnet.id}
      clusterMode: ${redisClusterClusterMode}
      definedTags:
        foo-namespace.bar-key: value
      freeformTags:
        bar-key: value
      nsgIds: ${redisClusterNsgIds}
      shardCount: ${redisClusterShardCount}

    Create RedisCluster Resource

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

    Constructor syntax

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

@overload
def RedisCluster(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 compartment_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 node_count: Optional[int] = None,
                 node_memory_in_gbs: Optional[float] = None,
                 software_version: Optional[str] = None,
                 subnet_id: Optional[str] = None,
                 cluster_mode: Optional[str] = None,
                 defined_tags: Optional[Mapping[str, str]] = None,
                 freeform_tags: Optional[Mapping[str, str]] = None,
                 nsg_ids: Optional[Sequence[str]] = None,
                 shard_count: Optional[int] = None)
    func NewRedisCluster(ctx *Context, name string, args RedisClusterArgs, opts ...ResourceOption) (*RedisCluster, error)
    public RedisCluster(string name, RedisClusterArgs args, CustomResourceOptions? opts = null)
    public RedisCluster(String name, RedisClusterArgs args)
public RedisCluster(String name, RedisClusterArgs args, CustomResourceOptions options)

    type: oci:Redis:RedisCluster
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 RedisClusterArgs
    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 RedisClusterArgs
    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 RedisClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RedisClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RedisClusterArgs
    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 redisClusterResource = new Oci.Redis.RedisCluster("redisClusterResource", new()
{
    CompartmentId = "string",
    DisplayName = "string",
    NodeCount = 0,
    NodeMemoryInGbs = 0,
    SoftwareVersion = "string",
    SubnetId = "string",
    ClusterMode = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    NsgIds = new[]
    {
        "string",
    },
    ShardCount = 0,
});

    example, err := Redis.NewRedisCluster(ctx, "redisClusterResource", &Redis.RedisClusterArgs{
	CompartmentId:   pulumi.String("string"),
	DisplayName:     pulumi.String("string"),
	NodeCount:       pulumi.Int(0),
	NodeMemoryInGbs: pulumi.Float64(0),
	SoftwareVersion: pulumi.String("string"),
	SubnetId:        pulumi.String("string"),
	ClusterMode:     pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	NsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	ShardCount: pulumi.Int(0),
})

    var redisClusterResource = new RedisCluster("redisClusterResource", RedisClusterArgs.builder()
    .compartmentId("string")
    .displayName("string")
    .nodeCount(0)
    .nodeMemoryInGbs(0)
    .softwareVersion("string")
    .subnetId("string")
    .clusterMode("string")
    .definedTags(Map.of("string", "string"))
    .freeformTags(Map.of("string", "string"))
    .nsgIds("string")
    .shardCount(0)
    .build());

    redis_cluster_resource = oci.redis.RedisCluster("redisClusterResource",
    compartment_id="string",
    display_name="string",
    node_count=0,
    node_memory_in_gbs=0,
    software_version="string",
    subnet_id="string",
    cluster_mode="string",
    defined_tags={
        "string": "string",
    },
    freeform_tags={
        "string": "string",
    },
    nsg_ids=["string"],
    shard_count=0)

    const redisClusterResource = new oci.redis.RedisCluster("redisClusterResource", {
    compartmentId: "string",
    displayName: "string",
    nodeCount: 0,
    nodeMemoryInGbs: 0,
    softwareVersion: "string",
    subnetId: "string",
    clusterMode: "string",
    definedTags: {
        string: "string",
    },
    freeformTags: {
        string: "string",
    },
    nsgIds: ["string"],
    shardCount: 0,
});

    type: oci:Redis:RedisCluster
properties:
    clusterMode: string
    compartmentId: string
    definedTags:
        string: string
    displayName: string
    freeformTags:
        string: string
    nodeCount: 0
    nodeMemoryInGbs: 0
    nsgIds:
        - string
    shardCount: 0
    softwareVersion: string
    subnetId: string

    RedisCluster 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 RedisCluster resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment that contains the cluster.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    NodeCount int
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    SoftwareVersion string
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    SubnetId string

    The OCID of the cluster's subnet.

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

    ClusterMode string
    Specifies whether the cluster is sharded or non-sharded.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    NsgIds List<string>
    (Updatable) A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    ShardCount int
    (Updatable) The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the cluster.
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    NodeCount int
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    SoftwareVersion string
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    SubnetId string

    The OCID of the cluster's subnet.

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

    ClusterMode string
    Specifies whether the cluster is sharded or non-sharded.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    NsgIds []string
    (Updatable) A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    ShardCount int
    (Updatable) The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the cluster.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    nodeCount Integer
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    softwareVersion String
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    subnetId String

    The OCID of the cluster's subnet.

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

    clusterMode String
    Specifies whether the cluster is sharded or non-sharded.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    nsgIds List<String>
    (Updatable) A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    shardCount Integer
    (Updatable) The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
    compartmentId string
    (Updatable) The OCID of the compartment that contains the cluster.
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    nodeCount number
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    softwareVersion string
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    subnetId string

    The OCID of the cluster's subnet.

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

    clusterMode string
    Specifies whether the cluster is sharded or non-sharded.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    nsgIds string[]
    (Updatable) A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    shardCount number
    (Updatable) The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
    compartment_id str
    (Updatable) The OCID of the compartment that contains the cluster.
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    node_count int
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    software_version str
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    subnet_id str

    The OCID of the cluster's subnet.

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

    cluster_mode str
    Specifies whether the cluster is sharded or non-sharded.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    nsg_ids Sequence[str]
    (Updatable) A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    shard_count int
    (Updatable) The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.
    compartmentId String
    (Updatable) The OCID of the compartment that contains the cluster.
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    nodeCount Number
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    softwareVersion String
    The Oracle Cloud Infrastructure Cache engine version that the cluster is running.
    subnetId String

    The OCID of the cluster's subnet.

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

    clusterMode String
    Specifies whether the cluster is sharded or non-sharded.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    nsgIds List<String>
    (Updatable) A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.
    shardCount Number
    (Updatable) The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    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<RedisClusterNodeCollection>
    The collection of cluster nodes.
    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.
    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.
    State string
    The current state of the cluster.
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    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 []RedisClusterNodeCollection
    The collection of cluster nodes.
    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.
    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.
    State string
    The current state of the cluster.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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<ClusterNodeCollection>
    The collection of cluster nodes.
    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.
    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.
    state String
    The current state of the cluster.
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    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 RedisClusterNodeCollection[]
    The collection of cluster nodes.
    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.
    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.
    state string
    The current state of the cluster.
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    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.RedisClusterNodeCollection]
    The collection of cluster nodes.
    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.
    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.
    state str
    The current state of the cluster.
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    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.
    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.
    state String
    The current state of the cluster.
    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.

    Look up Existing RedisCluster Resource

    Get an existing RedisCluster 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?: RedisClusterState, opts?: CustomResourceOptions): RedisCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_mode: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        lifecycle_details: Optional[str] = None,
        node_collections: Optional[Sequence[_redis.RedisClusterNodeCollectionArgs]] = None,
        node_count: Optional[int] = None,
        node_memory_in_gbs: Optional[float] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        primary_endpoint_ip_address: Optional[str] = None,
        primary_fqdn: Optional[str] = None,
        replicas_endpoint_ip_address: Optional[str] = None,
        replicas_fqdn: Optional[str] = None,
        shard_count: Optional[int] = None,
        software_version: Optional[str] = None,
        state: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> RedisCluster
    func GetRedisCluster(ctx *Context, name string, id IDInput, state *RedisClusterState, opts ...ResourceOption) (*RedisCluster, error)
    public static RedisCluster Get(string name, Input<string> id, RedisClusterState? state, CustomResourceOptions? opts = null)
    public static RedisCluster get(String name, Output<String> id, RedisClusterState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ClusterMode string
    Specifies whether the cluster is sharded or non-sharded.
    CompartmentId string
    (Updatable) The OCID of the compartment that contains the cluster.
    DefinedTags Dictionary<string, string>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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<RedisClusterNodeCollection>
    The collection of cluster nodes.
    NodeCount int
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    NsgIds List<string>
    (Updatable) 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.
    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
    (Updatable) The number of shards in 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.

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

    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
    (Updatable) The OCID of the compartment that contains the cluster.
    DefinedTags map[string]string
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 []RedisClusterNodeCollectionArgs
    The collection of cluster nodes.
    NodeCount int
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    NsgIds []string
    (Updatable) 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.
    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
    (Updatable) The number of shards in 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.

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

    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
    (Updatable) The OCID of the compartment that contains the cluster.
    definedTags Map<String,String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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<ClusterNodeCollection>
    The collection of cluster nodes.
    nodeCount Integer
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsgIds List<String>
    (Updatable) 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.
    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
    (Updatable) The number of shards in 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.

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

    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
    (Updatable) The OCID of the compartment that contains the cluster.
    definedTags {[key: string]: string}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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 RedisClusterNodeCollection[]
    The collection of cluster nodes.
    nodeCount number
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsgIds string[]
    (Updatable) 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.
    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
    (Updatable) The number of shards in 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.

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

    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
    (Updatable) The OCID of the compartment that contains the cluster.
    defined_tags Mapping[str, str]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    display_name str
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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.RedisClusterNodeCollectionArgs]
    The collection of cluster nodes.
    node_count int
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsg_ids Sequence[str]
    (Updatable) 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.
    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
    (Updatable) The number of shards in 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.

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

    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
    (Updatable) The OCID of the compartment that contains the cluster.
    definedTags Map<String>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    displayName String
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    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
    (Updatable) 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
    (Updatable) The amount of memory allocated to the cluster's nodes, in gigabytes.
    nsgIds List<String>
    (Updatable) 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.
    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
    (Updatable) The number of shards in 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.

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

    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

    RedisClusterNodeCollection, RedisClusterNodeCollectionArgs

    Items List<RedisClusterNodeCollectionItem>
    Collection of node objects.
    Items []RedisClusterNodeCollectionItem
    Collection of node objects.
    items List<ClusterNodeCollectionItem>
    Collection of node objects.
    items RedisClusterNodeCollectionItem[]
    Collection of node objects.
    items List<Property Map>
    Collection of node objects.

    RedisClusterNodeCollectionItem, RedisClusterNodeCollectionItemArgs

    DisplayName string
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    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
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    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
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    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
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    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
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    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
    (Updatable) A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    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.

    Import

    RedisClusters can be imported using the id, e.g.

    $ pulumi import oci:Redis/redisCluster:RedisCluster test_redis_cluster "id"

    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 v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci