Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OpensearchClusterSummary

The summary of information about an OpenSearch cluster.

Properties

Functions

Properties

Optional availabilityDomains

availabilityDomains: Array<string>

The availability domains to distribute the cluser nodes across.

compartmentId

compartmentId: string

The OCID for the compartment where the cluster is located.

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"}}}

Optional displayName

displayName: undefined | string

The name of the cluster. 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 cluster.

Optional lifecycleDetails

lifecycleDetails: undefined | string

Additional information about the current lifecycle state of the cluster.

Optional lifecycleState

lifecycleState: undefined | string

The current state of the cluster.

Optional securityMode

securityMode: model.SecurityMode

The security mode of the cluster.

softwareVersion

softwareVersion: string

The software version the cluster is running.

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 cluster was created. Format defined by RFC3339.

Optional timeUpdated

timeUpdated: Date

The date and time the cluster was updated. Format defined by RFC3339.

totalStorageGB

totalStorageGB: number

The total amount of storage in GB, for the cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Functions

getDeserializedJsonObj

getJsonObj