Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace OpensearchCluster

An OpenSearch cluster resource. An OpenSearch cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see About Search Service with OpenSearch.

Properties

availabilityDomains

availabilityDomains: Array<string>

The availability domains to distribute the cluser nodes across.

compartmentId

compartmentId: string

The OCID of the compartment where the cluster is located.

dataNodeCount

dataNodeCount: number

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

Optional dataNodeHostBareMetalShape

dataNodeHostBareMetalShape: undefined | string

The bare metal shape for the cluster's data nodes.

dataNodeHostMemoryGB

dataNodeHostMemoryGB: number

The amount of memory in GB, for the cluster's data nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

dataNodeHostOcpuCount

dataNodeHostOcpuCount: number

The number of OCPUs configured for the cluster's data nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

dataNodeHostType

dataNodeHostType: DataNodeHostType

The instance type for the cluster's data nodes.

dataNodeStorageGB

dataNodeStorageGB: number

The amount of storage in GB, to configure per node for the cluster's data nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

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

The name of the cluster. Avoid entering confidential information.

Optional fqdn

fqdn: undefined | string

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

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.

lifecycleState

lifecycleState: LifecycleState

The current state of the cluster.

masterNodeCount

masterNodeCount: number

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

Optional masterNodeHostBareMetalShape

masterNodeHostBareMetalShape: undefined | string

The bare metal shape for the cluster's master nodes.

masterNodeHostMemoryGB

masterNodeHostMemoryGB: number

The amount of memory in GB, for the cluster's master nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

masterNodeHostOcpuCount

masterNodeHostOcpuCount: number

The number of OCPUs configured for cluster's master nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

masterNodeHostType

masterNodeHostType: MasterNodeHostType

The instance type for the cluster's master nodes.

opendashboardFqdn

opendashboardFqdn: string

The fully qualified domain name (FQDN) for the cluster's OpenSearch Dashboard API endpoint.

opendashboardNodeCount

opendashboardNodeCount: number

The number of OpenSearch Dashboard nodes configured for the cluster. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

opendashboardNodeHostMemoryGB

opendashboardNodeHostMemoryGB: number

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

opendashboardNodeHostOcpuCount

opendashboardNodeHostOcpuCount: number

The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

opendashboardPrivateIp

opendashboardPrivateIp: string

The private IP address for the cluster's OpenSearch Dashboard.

opensearchFqdn

opensearchFqdn: string

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

opensearchPrivateIp

opensearchPrivateIp: string

The cluster's private IP address.

Optional securityMasterUserName

securityMasterUserName: undefined | string

The name of the master user that are used to manage security config

Optional securityMasterUserPasswordHash

securityMasterUserPasswordHash: undefined | string

The password hash of the master user that are used to manage security config

Optional securityMode

securityMode: model.SecurityMode

The security mode of the cluster.

softwareVersion

softwareVersion: string

The software version the cluster is running.

subnetCompartmentId

subnetCompartmentId: string

The OCID for the compartment where the cluster's subnet is located.

subnetId

subnetId: string

The OCID of the 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"}}}

timeCreated

timeCreated: Date

The amount of time in milliseconds since the cluster was created.

Optional timeDeleted

timeDeleted: Date

The amount of time in milliseconds since the cluster was updated.

Optional timeUpdated

timeUpdated: Date

The amount of time in milliseconds since the cluster was updated.

totalStorageGB

totalStorageGB: number

The size in GB of the cluster's total storage. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

vcnCompartmentId

vcnCompartmentId: string

The OCID for the compartment where the cluster's VCN is located.

vcnId

vcnId: string

The OCID of the cluster's VCN.

Functions

getDeserializedJsonObj

getJsonObj