Show / Hide Table of Contents

Class CreateRedisClusterDetails

The configuration details for a new OCI Cache cluster. An OCI Cache cluster is a memory-based storage solution. For more information, see OCI Cache.

Inheritance
object
CreateRedisClusterDetails
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.RedisService.Models
Assembly: OCI.DotNetSDK.Redis.dll
Syntax
public class CreateRedisClusterDetails

Properties

ClusterMode

Declaration
[JsonProperty(PropertyName = "clusterMode")]
[JsonConverter(typeof(StringEnumConverter))]
public RedisCluster.ClusterModeEnum? ClusterMode { get; set; }
Property Value
Type Description
RedisCluster.ClusterModeEnum?

Specifies whether the cluster is sharded or non-sharded.

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment that contains the cluster.

Remarks

Required

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Remarks

Required

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

NodeCount

Declaration
[Required(ErrorMessage = "NodeCount is required.")]
[JsonProperty(PropertyName = "nodeCount")]
public int? NodeCount { get; set; }
Property Value
Type Description
int?

The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.

Remarks

Required

NodeMemoryInGBs

Declaration
[Required(ErrorMessage = "NodeMemoryInGBs is required.")]
[JsonProperty(PropertyName = "nodeMemoryInGBs")]
public float? NodeMemoryInGBs { get; set; }
Property Value
Type Description
float?

The amount of memory allocated to the cluster's nodes, in gigabytes.

Remarks

Required

NsgIds

Declaration
[JsonProperty(PropertyName = "nsgIds")]
public List<string> NsgIds { get; set; }
Property Value
Type Description
List<string>

A list of Network Security Group (NSG) OCIDs associated with this cluster. For more information, see Using an NSG for Clusters.

ShardCount

Declaration
[JsonProperty(PropertyName = "shardCount")]
public int? ShardCount { get; set; }
Property Value
Type Description
int?

The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.

SoftwareVersion

Declaration
[Required(ErrorMessage = "SoftwareVersion is required.")]
[JsonProperty(PropertyName = "softwareVersion")]
[JsonConverter(typeof(StringEnumConverter))]
public RedisCluster.SoftwareVersionEnum? SoftwareVersion { get; set; }
Property Value
Type Description
RedisCluster.SoftwareVersionEnum?

The OCI Cache engine version that the cluster is running.

Remarks

Required

SubnetId

Declaration
[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type Description
string

The OCID of the cluster's subnet.

Remarks

Required

In this article
Back to top