Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateOpensearchClusterDetails

The configuration details for a new OpenSearch cluster.

Properties

Optional backupPolicy

backupPolicy: model.BackupPolicy

Optional certificateConfig

certificateConfig: model.CertificateConfig

compartmentId

compartmentId: string

The OCID of the compartment to create the cluster in.

dataNodeCount

dataNodeCount: number

The number of data nodes to configure 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, to configure per node 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 to configure for the cluster's data nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional dataNodeHostShape

dataNodeHostShape: undefined | string

The node shape for the cluster's data nodes.

dataNodeHostType

dataNodeHostType: DataNodeHostType

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

Optional inboundClusterIds

inboundClusterIds: Array<string>

List of inbound clusters that will be queried using cross cluster search

Optional maintenanceDetails

maintenanceDetails: model.CreateMaintenanceDetails

masterNodeCount

masterNodeCount: number

The number of master nodes to configure 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, to configure per node 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 to configure for the cluser's master nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional masterNodeHostShape

masterNodeHostShape: undefined | string

The node shape for the cluster's master nodes.

masterNodeHostType

masterNodeHostType: MasterNodeHostType

The instance type for the cluster's master nodes.

Optional nsgId

nsgId: undefined | string

The OCID of the NSG where the private endpoint vnic will be attached.

opendashboardNodeCount

opendashboardNodeCount: number

The number of OpenSearch Dashboard nodes to configure 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, to configure for the cluster's OpenSearch Dashboard nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

opendashboardNodeHostOcpuCount

opendashboardNodeHostOcpuCount: number

The number of OCPUs to configure for the cluster's OpenSearch Dashboard nodes. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional opendashboardNodeHostShape

opendashboardNodeHostShape: undefined | string

The node shape for the cluster's OpenSearch Dashboard nodes.

Optional outboundClusterConfig

outboundClusterConfig: model.OutboundClusterConfig

Optional reverseConnectionEndpointCustomerIps

reverseConnectionEndpointCustomerIps: Array<string>

The customer IP addresses of the endpoint in customer VCN

Optional searchNodeCount

searchNodeCount: undefined | number

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

Optional searchNodeHostMemoryGB

searchNodeHostMemoryGB: undefined | number

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

Optional searchNodeHostOcpuCount

searchNodeHostOcpuCount: undefined | number

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

Optional searchNodeHostShape

searchNodeHostShape: undefined | string

The node shape for the cluster's search nodes.

Optional searchNodeHostType

searchNodeHostType: model.SearchNodeHostType

The instance type for the cluster's search nodes.

Optional searchNodeStorageGB

searchNodeStorageGB: undefined | number

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

Optional securityAttributes

securityAttributes: undefined | object

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}}

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.

Optional securitySamlConfig

securitySamlConfig: model.SecuritySamlConfig

softwareVersion

softwareVersion: string

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

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