CreateRedisClusterDetails¶

class oci.redis.models.CreateRedisClusterDetails(**kwargs)¶

Bases: object

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.

Methods

__init__(**kwargs) Initializes a new CreateRedisClusterDetails object with values from keyword arguments.

Attributes

`cluster_mode`	Gets the cluster_mode of this CreateRedisClusterDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateRedisClusterDetails.
`defined_tags`	Gets the defined_tags of this CreateRedisClusterDetails.
`display_name`	[Required] Gets the display_name of this CreateRedisClusterDetails.
`freeform_tags`	Gets the freeform_tags of this CreateRedisClusterDetails.
`node_count`	[Required] Gets the node_count of this CreateRedisClusterDetails.
`node_memory_in_gbs`	[Required] Gets the node_memory_in_gbs of this CreateRedisClusterDetails.
`nsg_ids`	Gets the nsg_ids of this CreateRedisClusterDetails.
`shard_count`	Gets the shard_count of this CreateRedisClusterDetails.
`software_version`	[Required] Gets the software_version of this CreateRedisClusterDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreateRedisClusterDetails.

__init__(**kwargs)¶

Initializes a new CreateRedisClusterDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

cluster_mode (str) – The value to assign to the cluster_mode property of this CreateRedisClusterDetails.
shard_count (int) – The value to assign to the shard_count property of this CreateRedisClusterDetails.
display_name (str) – The value to assign to the display_name property of this CreateRedisClusterDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateRedisClusterDetails.
node_count (int) – The value to assign to the node_count property of this CreateRedisClusterDetails.
software_version (str) – The value to assign to the software_version property of this CreateRedisClusterDetails.
node_memory_in_gbs (float) – The value to assign to the node_memory_in_gbs property of this CreateRedisClusterDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateRedisClusterDetails.
nsg_ids (list[str]) – The value to assign to the nsg_ids property of this CreateRedisClusterDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateRedisClusterDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateRedisClusterDetails.

cluster_mode¶

Gets the cluster_mode of this CreateRedisClusterDetails. Specifies whether the cluster is sharded or non-sharded.

Returns:	The cluster_mode of this CreateRedisClusterDetails.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this CreateRedisClusterDetails. The OCID of the compartment that contains the cluster.

Returns:	The compartment_id of this CreateRedisClusterDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateRedisClusterDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateRedisClusterDetails.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this CreateRedisClusterDetails. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this CreateRedisClusterDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateRedisClusterDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateRedisClusterDetails.
Return type:	dict(str, str)

node_count¶

[Required] Gets the node_count of this CreateRedisClusterDetails. The number of nodes per shard in the cluster when clusterMode is SHARDED. This is the total number of nodes when clusterMode is NONSHARDED.

Returns:	The node_count of this CreateRedisClusterDetails.
Return type:	int

node_memory_in_gbs¶

[Required] Gets the node_memory_in_gbs of this CreateRedisClusterDetails. The amount of memory allocated to the cluster’s nodes, in gigabytes.

Returns:	The node_memory_in_gbs of this CreateRedisClusterDetails.
Return type:	float

nsg_ids¶

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

Returns:	The nsg_ids of this CreateRedisClusterDetails.
Return type:	list[str]

shard_count¶

Gets the shard_count of this CreateRedisClusterDetails. The number of shards in sharded cluster. Only applicable when clusterMode is SHARDED.

Returns:	The shard_count of this CreateRedisClusterDetails.
Return type:	int

software_version¶

[Required] Gets the software_version of this CreateRedisClusterDetails. The OCI Cache engine version that the cluster is running.

Returns:	The software_version of this CreateRedisClusterDetails.
Return type:	str

subnet_id¶

[Required] Gets the subnet_id of this CreateRedisClusterDetails. The OCID of the cluster’s subnet.

Returns:	The subnet_id of this CreateRedisClusterDetails.
Return type:	str