Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace RedisCluster

A Redis cluster is a memory-based storage solution. For more information, see OCI Caching Service with Redis.

Properties

compartmentId

compartmentId: string

The OCID of the compartment that contains the Redis cluster.

Optional definedTags

definedTags: undefined | object

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

displayName

displayName: string

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

Optional freeformTags

freeformTags: undefined | object

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

id

id: string

The OCID of the Redis cluster.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message describing the current state in more detail. For example, the message might provide actionable information for a resource in {@code FAILED} state.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the Redis cluster.

nodeCollection

nodeCollection: NodeCollection

nodeCount

nodeCount: number

The number of nodes in the Redis cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

nodeMemoryInGBs

nodeMemoryInGBs: number

The amount of memory allocated to the Redis cluster's nodes, in gigabytes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional nsgIds

nsgIds: Array<string>

OCIDs of the NSGs to control access in the customer network

primaryEndpointIpAddress

primaryEndpointIpAddress: string

The private IP address of the API endpoint for the Redis cluster's primary node.

primaryFqdn

primaryFqdn: string

The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's primary node.

replicasEndpointIpAddress

replicasEndpointIpAddress: string

The private IP address of the API endpoint for the Redis cluster's replica nodes.

replicasFqdn

replicasFqdn: string

The fully qualified domain name (FQDN) of the API endpoint for the Redis cluster's replica nodes.

softwareVersion

softwareVersion: SoftwareVersion

The Redis version that the cluster is running.

subnetId

subnetId: string

The OCID of the Redis cluster's subnet.

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}

Optional timeCreated

timeCreated: Date

The date and time the Redis cluster was created. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

The date and time the Redis cluster was updated. An RFC3339 formatted datetime string.

Functions

getDeserializedJsonObj

getJsonObj