Class 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.

Inheritance

object

OpensearchCluster

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.OpensearchService.Models

Assembly: OCI.DotNetSDK.Opensearch.dll

Syntax

public class OpensearchCluster

Properties

AvailabilityDomains

Declaration

[Required(ErrorMessage = "AvailabilityDomains is required.")]
[JsonProperty(PropertyName = "availabilityDomains")]
public List<string> AvailabilityDomains { get; set; }

Property Value

Type	Description
List<string>	The availability domains to distribute the cluser nodes across.

Remarks

Required

BackupPolicy

Declaration

[JsonProperty(PropertyName = "backupPolicy")]
public BackupPolicy BackupPolicy { get; set; }

Property Value

Type	Description
BackupPolicy

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment where the cluster is located.

Remarks

Required

DataNodeCount

Declaration

[Required(ErrorMessage = "DataNodeCount is required.")]
[JsonProperty(PropertyName = "dataNodeCount")]
public int? DataNodeCount { get; set; }

Property Value

Type	Description
int?	The number of data nodes configured for the cluster.

Remarks

Required

DataNodeHostBareMetalShape

Declaration

[JsonProperty(PropertyName = "dataNodeHostBareMetalShape")]
public string DataNodeHostBareMetalShape { get; set; }

Property Value

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

DataNodeHostMemoryGB

Declaration

[Required(ErrorMessage = "DataNodeHostMemoryGB is required.")]
[JsonProperty(PropertyName = "dataNodeHostMemoryGB")]
public int? DataNodeHostMemoryGB { get; set; }

Property Value

Type	Description
int?	The amount of memory in GB, for the cluster's data nodes.

Remarks

Required

DataNodeHostOcpuCount

Declaration

[Required(ErrorMessage = "DataNodeHostOcpuCount is required.")]
[JsonProperty(PropertyName = "dataNodeHostOcpuCount")]
public int? DataNodeHostOcpuCount { get; set; }

Property Value

Type	Description
int?	The number of OCPUs configured for the cluster's data nodes.

Remarks

Required

DataNodeHostShape

Declaration

[JsonProperty(PropertyName = "dataNodeHostShape")]
public string DataNodeHostShape { get; set; }

Property Value

Type	Description
string	The node shape for the cluster's data nodes.

DataNodeHostType

Declaration

[Required(ErrorMessage = "DataNodeHostType is required.")]
[JsonProperty(PropertyName = "dataNodeHostType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public DataNodeHostType? DataNodeHostType { get; set; }

Property Value

Type	Description
DataNodeHostType?	The instance type for the cluster's data nodes.

Remarks

Required

DataNodeStorageGB

Declaration

[Required(ErrorMessage = "DataNodeStorageGB is required.")]
[JsonProperty(PropertyName = "dataNodeStorageGB")]
public int? DataNodeStorageGB { get; set; }

Property Value

Type	Description
int?	The amount of storage in GB, to configure per node for the cluster's data nodes.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	The name of the cluster. Avoid entering confidential information.

Remarks

Required

Fqdn

Declaration

[JsonProperty(PropertyName = "fqdn")]
public string Fqdn { get; set; }

Property Value

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

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the cluster.

Remarks

Required

InboundClusterIds

Declaration

[JsonProperty(PropertyName = "inboundClusterIds")]
public List<string> InboundClusterIds { get; set; }

Property Value

Type	Description
List<string>	List of inbound clusters for which this cluster is an outbound cluster

LifecycleDetails

Declaration

[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }

Property Value

Type	Description
string	Additional information about the current lifecycle state of the cluster.

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public OpensearchCluster.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
OpensearchCluster.LifecycleStateEnum?	The current state of the cluster.

Remarks

Required

MaintenanceDetails

Declaration

[JsonProperty(PropertyName = "maintenanceDetails")]
public MaintenanceDetails MaintenanceDetails { get; set; }

Property Value

Type	Description
MaintenanceDetails

MasterNodeCount

Declaration

[Required(ErrorMessage = "MasterNodeCount is required.")]
[JsonProperty(PropertyName = "masterNodeCount")]
public int? MasterNodeCount { get; set; }

Property Value

Type	Description
int?	The number of master nodes configured for the cluster.

Remarks

Required

MasterNodeHostBareMetalShape

Declaration

[JsonProperty(PropertyName = "masterNodeHostBareMetalShape")]
public string MasterNodeHostBareMetalShape { get; set; }

Property Value

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

MasterNodeHostMemoryGB

Declaration

[Required(ErrorMessage = "MasterNodeHostMemoryGB is required.")]
[JsonProperty(PropertyName = "masterNodeHostMemoryGB")]
public int? MasterNodeHostMemoryGB { get; set; }

Property Value

Type	Description
int?	The amount of memory in GB, for the cluster's master nodes.

Remarks

Required

MasterNodeHostOcpuCount

Declaration

[Required(ErrorMessage = "MasterNodeHostOcpuCount is required.")]
[JsonProperty(PropertyName = "masterNodeHostOcpuCount")]
public int? MasterNodeHostOcpuCount { get; set; }

Property Value

Type	Description
int?	The number of OCPUs configured for cluster's master nodes.

Remarks

Required

MasterNodeHostShape

Declaration

[JsonProperty(PropertyName = "masterNodeHostShape")]
public string MasterNodeHostShape { get; set; }

Property Value

Type	Description
string	The node shape for the cluster's master nodes.

MasterNodeHostType

Declaration

[Required(ErrorMessage = "MasterNodeHostType is required.")]
[JsonProperty(PropertyName = "masterNodeHostType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public MasterNodeHostType? MasterNodeHostType { get; set; }

Property Value

Type	Description
MasterNodeHostType?	The instance type for the cluster's master nodes.

Remarks

Required

OpendashboardFqdn

Declaration

[Required(ErrorMessage = "OpendashboardFqdn is required.")]
[JsonProperty(PropertyName = "opendashboardFqdn")]
public string OpendashboardFqdn { get; set; }

Property Value

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

Remarks

Required

OpendashboardNodeCount

Declaration

[Required(ErrorMessage = "OpendashboardNodeCount is required.")]
[JsonProperty(PropertyName = "opendashboardNodeCount")]
public int? OpendashboardNodeCount { get; set; }

Property Value

Type	Description
int?	The number of OpenSearch Dashboard nodes configured for the cluster.

Remarks

Required

OpendashboardNodeHostMemoryGB

Declaration

[Required(ErrorMessage = "OpendashboardNodeHostMemoryGB is required.")]
[JsonProperty(PropertyName = "opendashboardNodeHostMemoryGB")]
public int? OpendashboardNodeHostMemoryGB { get; set; }

Property Value

Type	Description
int?	The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

Remarks

Required

OpendashboardNodeHostOcpuCount

Declaration

[Required(ErrorMessage = "OpendashboardNodeHostOcpuCount is required.")]
[JsonProperty(PropertyName = "opendashboardNodeHostOcpuCount")]
public int? OpendashboardNodeHostOcpuCount { get; set; }

Property Value

Type	Description
int?	The amount of memory in GB, for the cluster's OpenSearch Dashboard nodes.

Remarks

Required

OpendashboardNodeHostShape

Declaration

[JsonProperty(PropertyName = "opendashboardNodeHostShape")]
public string OpendashboardNodeHostShape { get; set; }

Property Value

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

OpendashboardPrivateIp

Declaration

[Required(ErrorMessage = "OpendashboardPrivateIp is required.")]
[JsonProperty(PropertyName = "opendashboardPrivateIp")]
public string OpendashboardPrivateIp { get; set; }

Property Value

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

Remarks

Required

OpensearchFqdn

Declaration

[Required(ErrorMessage = "OpensearchFqdn is required.")]
[JsonProperty(PropertyName = "opensearchFqdn")]
public string OpensearchFqdn { get; set; }

Property Value

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

Remarks

Required

OpensearchPrivateIp

Declaration

[Required(ErrorMessage = "OpensearchPrivateIp is required.")]
[JsonProperty(PropertyName = "opensearchPrivateIp")]
public string OpensearchPrivateIp { get; set; }

Property Value

Type	Description
string	The cluster's private IP address.

Remarks

Required

OutboundClusterConfig

Declaration

[JsonProperty(PropertyName = "outboundClusterConfig")]
public OutboundClusterConfig OutboundClusterConfig { get; set; }

Property Value

Type	Description
OutboundClusterConfig

ReverseConnectionEndpointCustomerIps

Declaration

[JsonProperty(PropertyName = "reverseConnectionEndpointCustomerIps")]
public List<string> ReverseConnectionEndpointCustomerIps { get; set; }

Property Value

Type	Description
List<string>	The customer IP addresses of the endpoint in customer VCN

ReverseConnectionEndpoints

Declaration

[JsonProperty(PropertyName = "reverseConnectionEndpoints")]
public List<ReverseConnectionEndpoint> ReverseConnectionEndpoints { get; set; }

Property Value

Type	Description
List<ReverseConnectionEndpoint>	The list of reverse connection endpoints.

SearchNodeCount

Declaration

[JsonProperty(PropertyName = "searchNodeCount")]
public int? SearchNodeCount { get; set; }

Property Value

Type	Description
int?	The number of search nodes configured for the cluster.

SearchNodeHostMemoryGB

Declaration

[JsonProperty(PropertyName = "searchNodeHostMemoryGB")]
public int? SearchNodeHostMemoryGB { get; set; }

Property Value

Type	Description
int?	The amount of memory in GB, for the cluster's search nodes.

SearchNodeHostOcpuCount

Declaration

[JsonProperty(PropertyName = "searchNodeHostOcpuCount")]
public int? SearchNodeHostOcpuCount { get; set; }

Property Value

Type	Description
int?	The number of OCPUs configured for the cluster's search nodes.

SearchNodeHostShape

Declaration

[JsonProperty(PropertyName = "searchNodeHostShape")]
public string SearchNodeHostShape { get; set; }

Property Value

Type	Description
string	The node shape for the cluster's search nodes.

SearchNodeHostType

Declaration

[JsonProperty(PropertyName = "searchNodeHostType")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SearchNodeHostType? SearchNodeHostType { get; set; }

Property Value

Type	Description
SearchNodeHostType?	The instance type for the cluster's search nodes.

SearchNodeStorageGB

Declaration

[JsonProperty(PropertyName = "searchNodeStorageGB")]
public int? SearchNodeStorageGB { get; set; }

Property Value

Type	Description
int?	The amount of storage in GB, to configure per node for the cluster's search nodes.

SecurityMasterUserName

Declaration

[JsonProperty(PropertyName = "securityMasterUserName")]
public string SecurityMasterUserName { get; set; }

Property Value

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

SecurityMasterUserPasswordHash

Declaration

[JsonProperty(PropertyName = "securityMasterUserPasswordHash")]
public string SecurityMasterUserPasswordHash { get; set; }

Property Value

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

SecurityMode

Declaration

[JsonProperty(PropertyName = "securityMode")]
[JsonConverter(typeof(ResponseEnumConverter))]
public SecurityMode? SecurityMode { get; set; }

Property Value

Type	Description
SecurityMode?	The security mode of the cluster.

SecuritySamlConfig

Declaration

[JsonProperty(PropertyName = "securitySamlConfig")]
public SecuritySamlConfig SecuritySamlConfig { get; set; }

Property Value

Type	Description
SecuritySamlConfig

SoftwareVersion

Declaration

[Required(ErrorMessage = "SoftwareVersion is required.")]
[JsonProperty(PropertyName = "softwareVersion")]
public string SoftwareVersion { get; set; }

Property Value

Type	Description
string	The software version the cluster is running.

Remarks

Required

SubnetCompartmentId

Declaration

[Required(ErrorMessage = "SubnetCompartmentId is required.")]
[JsonProperty(PropertyName = "subnetCompartmentId")]
public string SubnetCompartmentId { get; set; }

Property Value

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

Remarks

Required

SubnetId

Declaration

[Required(ErrorMessage = "SubnetId is required.")]
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }

Property Value

Type	Description
string	The OCID of the cluster's subnet.

Remarks

Required

SystemTags

Declaration

[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The amount of time in milliseconds since the cluster was created.

Remarks

Required

TimeDeleted

Declaration

[JsonProperty(PropertyName = "timeDeleted")]
public DateTime? TimeDeleted { get; set; }

Property Value

Type	Description
DateTime?	The amount of time in milliseconds since the cluster was updated.

TimeUpdated

Declaration

[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	The amount of time in milliseconds since the cluster was updated.

TotalStorageGB

Declaration

[Required(ErrorMessage = "TotalStorageGB is required.")]
[JsonProperty(PropertyName = "totalStorageGB")]
public int? TotalStorageGB { get; set; }

Property Value

Type	Description
int?	The size in GB of the cluster's total storage.

Remarks

Required

VcnCompartmentId

Declaration

[Required(ErrorMessage = "VcnCompartmentId is required.")]
[JsonProperty(PropertyName = "vcnCompartmentId")]
public string VcnCompartmentId { get; set; }

Property Value

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

Remarks

Required

VcnId

Declaration

[Required(ErrorMessage = "VcnId is required.")]
[JsonProperty(PropertyName = "vcnId")]
public string VcnId { get; set; }

Property Value

Type	Description
string	The OCID of the cluster's VCN.

Remarks

Required