RedisClusterSummary

class oci.redis.models.RedisClusterSummary(**kwargs)

Bases: object

Summary of information about a cluster. A cluster is a memory-based storage solution. For more information, see OCI Cache.

Methods

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

Attributes

cluster_mode Gets the cluster_mode of this RedisClusterSummary.
compartment_id [Required] Gets the compartment_id of this RedisClusterSummary.
defined_tags Gets the defined_tags of this RedisClusterSummary.
display_name [Required] Gets the display_name of this RedisClusterSummary.
freeform_tags Gets the freeform_tags of this RedisClusterSummary.
id [Required] Gets the id of this RedisClusterSummary.
lifecycle_details Gets the lifecycle_details of this RedisClusterSummary.
lifecycle_state Gets the lifecycle_state of this RedisClusterSummary.
node_count [Required] Gets the node_count of this RedisClusterSummary.
node_memory_in_gbs [Required] Gets the node_memory_in_gbs of this RedisClusterSummary.
nsg_ids Gets the nsg_ids of this RedisClusterSummary.
primary_endpoint_ip_address [Required] Gets the primary_endpoint_ip_address of this RedisClusterSummary.
primary_fqdn [Required] Gets the primary_fqdn of this RedisClusterSummary.
replicas_endpoint_ip_address [Required] Gets the replicas_endpoint_ip_address of this RedisClusterSummary.
replicas_fqdn [Required] Gets the replicas_fqdn of this RedisClusterSummary.
shard_count Gets the shard_count of this RedisClusterSummary.
software_version [Required] Gets the software_version of this RedisClusterSummary.
subnet_id [Required] Gets the subnet_id of this RedisClusterSummary.
system_tags Gets the system_tags of this RedisClusterSummary.
time_created Gets the time_created of this RedisClusterSummary.
time_updated Gets the time_updated of this RedisClusterSummary.
__init__(**kwargs)

Initializes a new RedisClusterSummary 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 RedisClusterSummary.
  • display_name (str) – The value to assign to the display_name property of this RedisClusterSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this RedisClusterSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this RedisClusterSummary.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this RedisClusterSummary.
  • node_count (int) – The value to assign to the node_count property of this RedisClusterSummary.
  • node_memory_in_gbs (float) – The value to assign to the node_memory_in_gbs property of this RedisClusterSummary.
  • primary_fqdn (str) – The value to assign to the primary_fqdn property of this RedisClusterSummary.
  • primary_endpoint_ip_address (str) – The value to assign to the primary_endpoint_ip_address property of this RedisClusterSummary.
  • replicas_fqdn (str) – The value to assign to the replicas_fqdn property of this RedisClusterSummary.
  • replicas_endpoint_ip_address (str) – The value to assign to the replicas_endpoint_ip_address property of this RedisClusterSummary.
  • software_version (str) – The value to assign to the software_version property of this RedisClusterSummary.
  • subnet_id (str) – The value to assign to the subnet_id property of this RedisClusterSummary.
  • time_created (datetime) – The value to assign to the time_created property of this RedisClusterSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this RedisClusterSummary.
  • cluster_mode (str) – The value to assign to the cluster_mode property of this RedisClusterSummary.
  • shard_count (int) – The value to assign to the shard_count property of this RedisClusterSummary.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this RedisClusterSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RedisClusterSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RedisClusterSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this RedisClusterSummary.
cluster_mode

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

Returns:The cluster_mode of this RedisClusterSummary.
Return type:str
compartment_id

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

Returns:The compartment_id of this RedisClusterSummary.
Return type:str
defined_tags

Gets the defined_tags of this RedisClusterSummary. 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 RedisClusterSummary.
Return type:dict(str, dict(str, object))
display_name

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

Returns:The display_name of this RedisClusterSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this RedisClusterSummary. 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 RedisClusterSummary.
Return type:dict(str, str)
id

[Required] Gets the id of this RedisClusterSummary. The OCID of the cluster.

Returns:The id of this RedisClusterSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this RedisClusterSummary. 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 RedisClusterSummary.
Return type:str
lifecycle_state

Gets the lifecycle_state of this RedisClusterSummary. The current state of the cluster.

Returns:The lifecycle_state of this RedisClusterSummary.
Return type:str
node_count

[Required] Gets the node_count of this RedisClusterSummary. 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 RedisClusterSummary.
Return type:int
node_memory_in_gbs

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

Returns:The node_memory_in_gbs of this RedisClusterSummary.
Return type:float
nsg_ids

Gets the nsg_ids of this RedisClusterSummary. 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 RedisClusterSummary.
Return type:list[str]
primary_endpoint_ip_address

[Required] Gets the primary_endpoint_ip_address of this RedisClusterSummary. The private IP address of the API endpoint for the cluster’s primary node.

Returns:The primary_endpoint_ip_address of this RedisClusterSummary.
Return type:str
primary_fqdn

[Required] Gets the primary_fqdn of this RedisClusterSummary. The fully qualified domain name (FQDN) of the API endpoint for the cluster’s primary node.

Returns:The primary_fqdn of this RedisClusterSummary.
Return type:str
replicas_endpoint_ip_address

[Required] Gets the replicas_endpoint_ip_address of this RedisClusterSummary. The private IP address of the API endpoint for the cluster’s replica nodes.

Returns:The replicas_endpoint_ip_address of this RedisClusterSummary.
Return type:str
replicas_fqdn

[Required] Gets the replicas_fqdn of this RedisClusterSummary. The fully qualified domain name (FQDN) of the API endpoint for the cluster’s replica nodes.

Returns:The replicas_fqdn of this RedisClusterSummary.
Return type:str
shard_count

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

Returns:The shard_count of this RedisClusterSummary.
Return type:int
software_version

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

Returns:The software_version of this RedisClusterSummary.
Return type:str
subnet_id

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

Returns:The subnet_id of this RedisClusterSummary.
Return type:str
system_tags

Gets the system_tags of this RedisClusterSummary. 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 RedisClusterSummary.
Return type:dict(str, dict(str, object))
time_created

Gets the time_created of this RedisClusterSummary. The date and time the cluster was created. An RFC3339 formatted datetime string.

Returns:The time_created of this RedisClusterSummary.
Return type:datetime
time_updated

Gets the time_updated of this RedisClusterSummary. The date and time the cluster was updated. An RFC3339 formatted datetime string.

Returns:The time_updated of this RedisClusterSummary.
Return type:datetime