Class CreateOpensearchClusterDetails

The configuration details for a new OpenSearch cluster.

Inheritance

object

CreateOpensearchClusterDetails

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 CreateOpensearchClusterDetails

Properties

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 to create the cluster in.

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 to configure 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, to configure per node 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 to configure 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(StringEnumConverter))]
public DataNodeHostType? DataNodeHostType { get; set; }

Property Value

Type	Description
DataNodeHostType?	TThe 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

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

InboundClusterIds

Declaration

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

Property Value

Type	Description
List<string>	List of inbound clusters that will be queried using cross cluster search

MaintenanceDetails

Declaration

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

Property Value

Type	Description
CreateMaintenanceDetails

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 to configure 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, to configure per node 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 to configure for the cluser'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(StringEnumConverter))]
public MasterNodeHostType? MasterNodeHostType { get; set; }

Property Value

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

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 to configure 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, to configure 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 number of OCPUs to configure 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.

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

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(StringEnumConverter))]
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(StringEnumConverter))]
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 version of the software 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"}}

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