RedisCluster¶
-
class
oci.redis.models.
RedisCluster
(**kwargs)¶ Bases:
object
An OCI Cache cluster is a memory-based storage solution. For more information, see OCI Cache.
Attributes
CLUSTER_MODE_NONSHARDED
A constant which can be used with the cluster_mode property of a RedisCluster. CLUSTER_MODE_SHARDED
A constant which can be used with the cluster_mode property of a RedisCluster. LIFECYCLE_STATE_ACTIVE
A constant which can be used with the lifecycle_state property of a RedisCluster. LIFECYCLE_STATE_CREATING
A constant which can be used with the lifecycle_state property of a RedisCluster. LIFECYCLE_STATE_DELETED
A constant which can be used with the lifecycle_state property of a RedisCluster. LIFECYCLE_STATE_DELETING
A constant which can be used with the lifecycle_state property of a RedisCluster. LIFECYCLE_STATE_FAILED
A constant which can be used with the lifecycle_state property of a RedisCluster. LIFECYCLE_STATE_UPDATING
A constant which can be used with the lifecycle_state property of a RedisCluster. SOFTWARE_VERSION_REDIS_7_0
A constant which can be used with the software_version property of a RedisCluster. SOFTWARE_VERSION_V7_0_5
A constant which can be used with the software_version property of a RedisCluster. cluster_mode
Gets the cluster_mode of this RedisCluster. compartment_id
[Required] Gets the compartment_id of this RedisCluster. defined_tags
Gets the defined_tags of this RedisCluster. display_name
[Required] Gets the display_name of this RedisCluster. freeform_tags
Gets the freeform_tags of this RedisCluster. id
[Required] Gets the id of this RedisCluster. lifecycle_details
Gets the lifecycle_details of this RedisCluster. lifecycle_state
Gets the lifecycle_state of this RedisCluster. node_collection
[Required] Gets the node_collection of this RedisCluster. node_count
[Required] Gets the node_count of this RedisCluster. node_memory_in_gbs
[Required] Gets the node_memory_in_gbs of this RedisCluster. nsg_ids
Gets the nsg_ids of this RedisCluster. primary_endpoint_ip_address
[Required] Gets the primary_endpoint_ip_address of this RedisCluster. primary_fqdn
[Required] Gets the primary_fqdn of this RedisCluster. replicas_endpoint_ip_address
[Required] Gets the replicas_endpoint_ip_address of this RedisCluster. replicas_fqdn
[Required] Gets the replicas_fqdn of this RedisCluster. shard_count
Gets the shard_count of this RedisCluster. software_version
[Required] Gets the software_version of this RedisCluster. subnet_id
[Required] Gets the subnet_id of this RedisCluster. system_tags
Gets the system_tags of this RedisCluster. time_created
Gets the time_created of this RedisCluster. time_updated
Gets the time_updated of this RedisCluster. Methods
__init__
(**kwargs)Initializes a new RedisCluster object with values from keyword arguments. -
CLUSTER_MODE_NONSHARDED
= 'NONSHARDED'¶ A constant which can be used with the cluster_mode property of a RedisCluster. This constant has a value of “NONSHARDED”
-
CLUSTER_MODE_SHARDED
= 'SHARDED'¶ A constant which can be used with the cluster_mode property of a RedisCluster. This constant has a value of “SHARDED”
-
LIFECYCLE_STATE_ACTIVE
= 'ACTIVE'¶ A constant which can be used with the lifecycle_state property of a RedisCluster. This constant has a value of “ACTIVE”
-
LIFECYCLE_STATE_CREATING
= 'CREATING'¶ A constant which can be used with the lifecycle_state property of a RedisCluster. This constant has a value of “CREATING”
-
LIFECYCLE_STATE_DELETED
= 'DELETED'¶ A constant which can be used with the lifecycle_state property of a RedisCluster. This constant has a value of “DELETED”
-
LIFECYCLE_STATE_DELETING
= 'DELETING'¶ A constant which can be used with the lifecycle_state property of a RedisCluster. This constant has a value of “DELETING”
-
LIFECYCLE_STATE_FAILED
= 'FAILED'¶ A constant which can be used with the lifecycle_state property of a RedisCluster. This constant has a value of “FAILED”
-
LIFECYCLE_STATE_UPDATING
= 'UPDATING'¶ A constant which can be used with the lifecycle_state property of a RedisCluster. This constant has a value of “UPDATING”
-
SOFTWARE_VERSION_REDIS_7_0
= 'REDIS_7_0'¶ A constant which can be used with the software_version property of a RedisCluster. This constant has a value of “REDIS_7_0”
-
SOFTWARE_VERSION_V7_0_5
= 'V7_0_5'¶ A constant which can be used with the software_version property of a RedisCluster. This constant has a value of “V7_0_5”
-
__init__
(**kwargs)¶ Initializes a new RedisCluster object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
Parameters: - id (str) – The value to assign to the id property of this RedisCluster.
- display_name (str) – The value to assign to the display_name property of this RedisCluster.
- compartment_id (str) – The value to assign to the compartment_id property of this RedisCluster.
- lifecycle_state (str) – The value to assign to the lifecycle_state property of this RedisCluster. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- lifecycle_details (str) – The value to assign to the lifecycle_details property of this RedisCluster.
- node_count (int) – The value to assign to the node_count property of this RedisCluster.
- node_memory_in_gbs (float) – The value to assign to the node_memory_in_gbs property of this RedisCluster.
- primary_fqdn (str) – The value to assign to the primary_fqdn property of this RedisCluster.
- primary_endpoint_ip_address (str) – The value to assign to the primary_endpoint_ip_address property of this RedisCluster.
- replicas_fqdn (str) – The value to assign to the replicas_fqdn property of this RedisCluster.
- replicas_endpoint_ip_address (str) – The value to assign to the replicas_endpoint_ip_address property of this RedisCluster.
- software_version (str) – The value to assign to the software_version property of this RedisCluster. Allowed values for this property are: “V7_0_5”, “REDIS_7_0”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- subnet_id (str) – The value to assign to the subnet_id property of this RedisCluster.
- time_created (datetime) – The value to assign to the time_created property of this RedisCluster.
- time_updated (datetime) – The value to assign to the time_updated property of this RedisCluster.
- node_collection (oci.redis.models.NodeCollection) – The value to assign to the node_collection property of this RedisCluster.
- cluster_mode (str) – The value to assign to the cluster_mode property of this RedisCluster. Allowed values for this property are: “SHARDED”, “NONSHARDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- shard_count (int) – The value to assign to the shard_count property of this RedisCluster.
- nsg_ids (list[str]) – The value to assign to the nsg_ids property of this RedisCluster.
- freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RedisCluster.
- defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RedisCluster.
- system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RedisCluster.
-
cluster_mode
¶ Gets the cluster_mode of this RedisCluster. Specifies whether the cluster is sharded or non-sharded.
Allowed values for this property are: “SHARDED”, “NONSHARDED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The cluster_mode of this RedisCluster. Return type: str
-
compartment_id
¶ [Required] Gets the compartment_id of this RedisCluster. The OCID of the compartment that contains the cluster.
Returns: The compartment_id of this RedisCluster. Return type: str
Gets the defined_tags of this RedisCluster. 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 RedisCluster. Return type: dict(str, dict(str, object))
-
display_name
¶ [Required] Gets the display_name of this RedisCluster. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Returns: The display_name of this RedisCluster. Return type: str
Gets the freeform_tags of this RedisCluster. 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 RedisCluster. Return type: dict(str, str)
-
id
¶ [Required] Gets the id of this RedisCluster. The OCID of the cluster.
Returns: The id of this RedisCluster. Return type: str
-
lifecycle_details
¶ Gets the lifecycle_details of this RedisCluster. A message describing the current state in more detail. For example, the message might provide actionable information for a resource in FAILED state.
Returns: The lifecycle_details of this RedisCluster. Return type: str
-
lifecycle_state
¶ Gets the lifecycle_state of this RedisCluster. The current state of the cluster.
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The lifecycle_state of this RedisCluster. Return type: str
-
node_collection
¶ [Required] Gets the node_collection of this RedisCluster.
Returns: The node_collection of this RedisCluster. Return type: oci.redis.models.NodeCollection
-
node_count
¶ [Required] Gets the node_count of this RedisCluster. 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 RedisCluster. Return type: int
-
node_memory_in_gbs
¶ [Required] Gets the node_memory_in_gbs of this RedisCluster. The amount of memory allocated to the cluster’s nodes, in gigabytes.
Returns: The node_memory_in_gbs of this RedisCluster. Return type: float
-
nsg_ids
¶ Gets the nsg_ids of this RedisCluster. 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 RedisCluster. Return type: list[str]
-
primary_endpoint_ip_address
¶ [Required] Gets the primary_endpoint_ip_address of this RedisCluster. The private IP address of the API endpoint for the cluster’s primary node.
Returns: The primary_endpoint_ip_address of this RedisCluster. Return type: str
-
primary_fqdn
¶ [Required] Gets the primary_fqdn of this RedisCluster. The fully qualified domain name (FQDN) of the API endpoint for the cluster’s primary node.
Returns: The primary_fqdn of this RedisCluster. Return type: str
-
replicas_endpoint_ip_address
¶ [Required] Gets the replicas_endpoint_ip_address of this RedisCluster. The private IP address of the API endpoint for the cluster’s replica nodes.
Returns: The replicas_endpoint_ip_address of this RedisCluster. Return type: str
-
replicas_fqdn
¶ [Required] Gets the replicas_fqdn of this RedisCluster. The fully qualified domain name (FQDN) of the API endpoint for the cluster’s replica nodes.
Returns: The replicas_fqdn of this RedisCluster. Return type: str
-
shard_count
¶ Gets the shard_count of this RedisCluster. The number of shards in a sharded cluster. Only applicable when clusterMode is SHARDED.
Returns: The shard_count of this RedisCluster. Return type: int
-
software_version
¶ [Required] Gets the software_version of this RedisCluster. The OCI Cache engine version that the cluster is running.
Allowed values for this property are: “V7_0_5”, “REDIS_7_0”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The software_version of this RedisCluster. Return type: str
-
subnet_id
¶ [Required] Gets the subnet_id of this RedisCluster. The OCID of the cluster’s subnet.
Returns: The subnet_id of this RedisCluster. Return type: str
Gets the system_tags of this RedisCluster. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}
Returns: The system_tags of this RedisCluster. Return type: dict(str, dict(str, object))
-