OpensearchCluster

class oci.opensearch.models.OpensearchCluster(**kwargs)

Bases: object

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.

Attributes:

COORDINATOR_NODE_HOST_TYPE_FLEX

A constant which can be used with the coordinator_node_host_type property of a OpensearchCluster.

DATA_NODE_HOST_TYPE_BM

A constant which can be used with the data_node_host_type property of a OpensearchCluster.

DATA_NODE_HOST_TYPE_FLEX

A constant which can be used with the data_node_host_type property of a OpensearchCluster.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a OpensearchCluster.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a OpensearchCluster.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a OpensearchCluster.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a OpensearchCluster.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a OpensearchCluster.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a OpensearchCluster.

MASTER_NODE_HOST_TYPE_BM

A constant which can be used with the master_node_host_type property of a OpensearchCluster.

MASTER_NODE_HOST_TYPE_FLEX

A constant which can be used with the master_node_host_type property of a OpensearchCluster.

ML_NODE_HOST_TYPE_FLEX

A constant which can be used with the ml_node_host_type property of a OpensearchCluster.

SEARCH_NODE_HOST_TYPE_FLEX

A constant which can be used with the search_node_host_type property of a OpensearchCluster.

SECURITY_MODE_DISABLED

A constant which can be used with the security_mode property of a OpensearchCluster.

SECURITY_MODE_ENFORCING

A constant which can be used with the security_mode property of a OpensearchCluster.

SECURITY_MODE_PERMISSIVE

A constant which can be used with the security_mode property of a OpensearchCluster.

availability_domains

[Required] Gets the availability_domains of this OpensearchCluster.

backup_policy

Gets the backup_policy of this OpensearchCluster.

certificate_config

Gets the certificate_config of this OpensearchCluster.

compartment_id

[Required] Gets the compartment_id of this OpensearchCluster.

coordinator_node_count

Gets the coordinator_node_count of this OpensearchCluster.

coordinator_node_host_memory_gb

Gets the coordinator_node_host_memory_gb of this OpensearchCluster.

coordinator_node_host_ocpu_count

Gets the coordinator_node_host_ocpu_count of this OpensearchCluster.

coordinator_node_host_shape

Gets the coordinator_node_host_shape of this OpensearchCluster.

coordinator_node_host_type

Gets the coordinator_node_host_type of this OpensearchCluster.

data_node_count

[Required] Gets the data_node_count of this OpensearchCluster.

data_node_host_bare_metal_shape

Gets the data_node_host_bare_metal_shape of this OpensearchCluster.

data_node_host_memory_gb

[Required] Gets the data_node_host_memory_gb of this OpensearchCluster.

data_node_host_ocpu_count

[Required] Gets the data_node_host_ocpu_count of this OpensearchCluster.

data_node_host_shape

Gets the data_node_host_shape of this OpensearchCluster.

data_node_host_type

[Required] Gets the data_node_host_type of this OpensearchCluster.

data_node_storage_gb

[Required] Gets the data_node_storage_gb of this OpensearchCluster.

defined_tags

Gets the defined_tags of this OpensearchCluster.

display_name

[Required] Gets the display_name of this OpensearchCluster.

fqdn

Gets the fqdn of this OpensearchCluster.

freeform_tags

Gets the freeform_tags of this OpensearchCluster.

id

[Required] Gets the id of this OpensearchCluster.

inbound_cluster_ids

Gets the inbound_cluster_ids of this OpensearchCluster.

lifecycle_details

Gets the lifecycle_details of this OpensearchCluster.

lifecycle_state

[Required] Gets the lifecycle_state of this OpensearchCluster.

load_balancer_config

Gets the load_balancer_config of this OpensearchCluster.

maintenance_details

Gets the maintenance_details of this OpensearchCluster.

master_node_count

[Required] Gets the master_node_count of this OpensearchCluster.

master_node_host_bare_metal_shape

Gets the master_node_host_bare_metal_shape of this OpensearchCluster.

master_node_host_memory_gb

[Required] Gets the master_node_host_memory_gb of this OpensearchCluster.

master_node_host_ocpu_count

[Required] Gets the master_node_host_ocpu_count of this OpensearchCluster.

master_node_host_shape

Gets the master_node_host_shape of this OpensearchCluster.

master_node_host_type

[Required] Gets the master_node_host_type of this OpensearchCluster.

ml_node_count

Gets the ml_node_count of this OpensearchCluster.

ml_node_host_memory_gb

Gets the ml_node_host_memory_gb of this OpensearchCluster.

ml_node_host_ocpu_count

Gets the ml_node_host_ocpu_count of this OpensearchCluster.

ml_node_host_shape

Gets the ml_node_host_shape of this OpensearchCluster.

ml_node_host_type

Gets the ml_node_host_type of this OpensearchCluster.

ml_node_storage_gb

Gets the ml_node_storage_gb of this OpensearchCluster.

nsg_id

Gets the nsg_id of this OpensearchCluster.

opendashboard_fqdn

[Required] Gets the opendashboard_fqdn of this OpensearchCluster.

opendashboard_node_count

[Required] Gets the opendashboard_node_count of this OpensearchCluster.

opendashboard_node_host_memory_gb

[Required] Gets the opendashboard_node_host_memory_gb of this OpensearchCluster.

opendashboard_node_host_ocpu_count

[Required] Gets the opendashboard_node_host_ocpu_count of this OpensearchCluster.

opendashboard_node_host_shape

Gets the opendashboard_node_host_shape of this OpensearchCluster.

opendashboard_private_ip

[Required] Gets the opendashboard_private_ip of this OpensearchCluster.

opensearch_fqdn

[Required] Gets the opensearch_fqdn of this OpensearchCluster.

opensearch_private_ip

[Required] Gets the opensearch_private_ip of this OpensearchCluster.

outbound_cluster_config

Gets the outbound_cluster_config of this OpensearchCluster.

remote_reindex_trust_config

Gets the remote_reindex_trust_config of this OpensearchCluster.

reverse_connection_endpoint_customer_ips

Gets the reverse_connection_endpoint_customer_ips of this OpensearchCluster.

reverse_connection_endpoints

Gets the reverse_connection_endpoints of this OpensearchCluster.

search_node_count

Gets the search_node_count of this OpensearchCluster.

search_node_host_memory_gb

Gets the search_node_host_memory_gb of this OpensearchCluster.

search_node_host_ocpu_count

Gets the search_node_host_ocpu_count of this OpensearchCluster.

search_node_host_shape

Gets the search_node_host_shape of this OpensearchCluster.

search_node_host_type

Gets the search_node_host_type of this OpensearchCluster.

search_node_storage_gb

Gets the search_node_storage_gb of this OpensearchCluster.

security_attributes

Gets the security_attributes of this OpensearchCluster.

security_master_user_name

Gets the security_master_user_name of this OpensearchCluster.

security_master_user_password_hash

Gets the security_master_user_password_hash of this OpensearchCluster.

security_mode

Gets the security_mode of this OpensearchCluster.

security_saml_config

Gets the security_saml_config of this OpensearchCluster.

software_version

[Required] Gets the software_version of this OpensearchCluster.

subnet_compartment_id

[Required] Gets the subnet_compartment_id of this OpensearchCluster.

subnet_id

[Required] Gets the subnet_id of this OpensearchCluster.

system_tags

Gets the system_tags of this OpensearchCluster.

time_created

[Required] Gets the time_created of this OpensearchCluster.

time_deleted

Gets the time_deleted of this OpensearchCluster.

time_updated

Gets the time_updated of this OpensearchCluster.

total_storage_gb

[Required] Gets the total_storage_gb of this OpensearchCluster.

vcn_compartment_id

[Required] Gets the vcn_compartment_id of this OpensearchCluster.

vcn_id

[Required] Gets the vcn_id of this OpensearchCluster.

Methods:

__init__(**kwargs)

Initializes a new OpensearchCluster object with values from keyword arguments.

COORDINATOR_NODE_HOST_TYPE_FLEX = 'FLEX'

A constant which can be used with the coordinator_node_host_type property of a OpensearchCluster. This constant has a value of “FLEX”

DATA_NODE_HOST_TYPE_BM = 'BM'

A constant which can be used with the data_node_host_type property of a OpensearchCluster. This constant has a value of “BM”

DATA_NODE_HOST_TYPE_FLEX = 'FLEX'

A constant which can be used with the data_node_host_type property of a OpensearchCluster. This constant has a value of “FLEX”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a OpensearchCluster. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a OpensearchCluster. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a OpensearchCluster. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a OpensearchCluster. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a OpensearchCluster. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a OpensearchCluster. This constant has a value of “UPDATING”

MASTER_NODE_HOST_TYPE_BM = 'BM'

A constant which can be used with the master_node_host_type property of a OpensearchCluster. This constant has a value of “BM”

MASTER_NODE_HOST_TYPE_FLEX = 'FLEX'

A constant which can be used with the master_node_host_type property of a OpensearchCluster. This constant has a value of “FLEX”

ML_NODE_HOST_TYPE_FLEX = 'FLEX'

A constant which can be used with the ml_node_host_type property of a OpensearchCluster. This constant has a value of “FLEX”

SEARCH_NODE_HOST_TYPE_FLEX = 'FLEX'

A constant which can be used with the search_node_host_type property of a OpensearchCluster. This constant has a value of “FLEX”

SECURITY_MODE_DISABLED = 'DISABLED'

A constant which can be used with the security_mode property of a OpensearchCluster. This constant has a value of “DISABLED”

SECURITY_MODE_ENFORCING = 'ENFORCING'

A constant which can be used with the security_mode property of a OpensearchCluster. This constant has a value of “ENFORCING”

SECURITY_MODE_PERMISSIVE = 'PERMISSIVE'

A constant which can be used with the security_mode property of a OpensearchCluster. This constant has a value of “PERMISSIVE”

__init__(**kwargs)

Initializes a new OpensearchCluster object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • id (str) – The value to assign to the id property of this OpensearchCluster.

  • display_name (str) – The value to assign to the display_name property of this OpensearchCluster.

  • compartment_id (str) – The value to assign to the compartment_id property of this OpensearchCluster.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpensearchCluster. Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • time_created (datetime) – The value to assign to the time_created property of this OpensearchCluster.

  • time_updated (datetime) – The value to assign to the time_updated property of this OpensearchCluster.

  • time_deleted (datetime) – The value to assign to the time_deleted property of this OpensearchCluster.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this OpensearchCluster.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OpensearchCluster.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OpensearchCluster.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OpensearchCluster.

  • security_attributes (dict(str, dict(str, object))) – The value to assign to the security_attributes property of this OpensearchCluster.

  • software_version (str) – The value to assign to the software_version property of this OpensearchCluster.

  • total_storage_gb (int) – The value to assign to the total_storage_gb property of this OpensearchCluster.

  • opensearch_fqdn (str) – The value to assign to the opensearch_fqdn property of this OpensearchCluster.

  • opensearch_private_ip (str) – The value to assign to the opensearch_private_ip property of this OpensearchCluster.

  • opendashboard_fqdn (str) – The value to assign to the opendashboard_fqdn property of this OpensearchCluster.

  • opendashboard_private_ip (str) – The value to assign to the opendashboard_private_ip property of this OpensearchCluster.

  • master_node_count (int) – The value to assign to the master_node_count property of this OpensearchCluster.

  • master_node_host_type (str) – The value to assign to the master_node_host_type property of this OpensearchCluster. Allowed values for this property are: “FLEX”, “BM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • master_node_host_bare_metal_shape (str) – The value to assign to the master_node_host_bare_metal_shape property of this OpensearchCluster.

  • master_node_host_shape (str) – The value to assign to the master_node_host_shape property of this OpensearchCluster.

  • master_node_host_ocpu_count (int) – The value to assign to the master_node_host_ocpu_count property of this OpensearchCluster.

  • master_node_host_memory_gb (int) – The value to assign to the master_node_host_memory_gb property of this OpensearchCluster.

  • data_node_count (int) – The value to assign to the data_node_count property of this OpensearchCluster.

  • data_node_host_type (str) – The value to assign to the data_node_host_type property of this OpensearchCluster. Allowed values for this property are: “FLEX”, “BM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • data_node_host_bare_metal_shape (str) – The value to assign to the data_node_host_bare_metal_shape property of this OpensearchCluster.

  • data_node_host_shape (str) – The value to assign to the data_node_host_shape property of this OpensearchCluster.

  • data_node_host_ocpu_count (int) – The value to assign to the data_node_host_ocpu_count property of this OpensearchCluster.

  • data_node_host_memory_gb (int) – The value to assign to the data_node_host_memory_gb property of this OpensearchCluster.

  • data_node_storage_gb (int) – The value to assign to the data_node_storage_gb property of this OpensearchCluster.

  • search_node_count (int) – The value to assign to the search_node_count property of this OpensearchCluster.

  • search_node_host_type (str) – The value to assign to the search_node_host_type property of this OpensearchCluster. Allowed values for this property are: “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • search_node_host_shape (str) – The value to assign to the search_node_host_shape property of this OpensearchCluster.

  • search_node_host_ocpu_count (int) – The value to assign to the search_node_host_ocpu_count property of this OpensearchCluster.

  • search_node_host_memory_gb (int) – The value to assign to the search_node_host_memory_gb property of this OpensearchCluster.

  • search_node_storage_gb (int) – The value to assign to the search_node_storage_gb property of this OpensearchCluster.

  • coordinator_node_count (int) – The value to assign to the coordinator_node_count property of this OpensearchCluster.

  • coordinator_node_host_type (str) – The value to assign to the coordinator_node_host_type property of this OpensearchCluster. Allowed values for this property are: “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • coordinator_node_host_shape (str) – The value to assign to the coordinator_node_host_shape property of this OpensearchCluster.

  • coordinator_node_host_ocpu_count (int) – The value to assign to the coordinator_node_host_ocpu_count property of this OpensearchCluster.

  • coordinator_node_host_memory_gb (int) – The value to assign to the coordinator_node_host_memory_gb property of this OpensearchCluster.

  • ml_node_count (int) – The value to assign to the ml_node_count property of this OpensearchCluster.

  • ml_node_host_type (str) – The value to assign to the ml_node_host_type property of this OpensearchCluster. Allowed values for this property are: “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • ml_node_host_shape (str) – The value to assign to the ml_node_host_shape property of this OpensearchCluster.

  • ml_node_host_ocpu_count (int) – The value to assign to the ml_node_host_ocpu_count property of this OpensearchCluster.

  • ml_node_host_memory_gb (int) – The value to assign to the ml_node_host_memory_gb property of this OpensearchCluster.

  • ml_node_storage_gb (int) – The value to assign to the ml_node_storage_gb property of this OpensearchCluster.

  • opendashboard_node_host_shape (str) – The value to assign to the opendashboard_node_host_shape property of this OpensearchCluster.

  • opendashboard_node_count (int) – The value to assign to the opendashboard_node_count property of this OpensearchCluster.

  • opendashboard_node_host_ocpu_count (int) – The value to assign to the opendashboard_node_host_ocpu_count property of this OpensearchCluster.

  • opendashboard_node_host_memory_gb (int) – The value to assign to the opendashboard_node_host_memory_gb property of this OpensearchCluster.

  • vcn_id (str) – The value to assign to the vcn_id property of this OpensearchCluster.

  • subnet_id (str) – The value to assign to the subnet_id property of this OpensearchCluster.

  • vcn_compartment_id (str) – The value to assign to the vcn_compartment_id property of this OpensearchCluster.

  • subnet_compartment_id (str) – The value to assign to the subnet_compartment_id property of this OpensearchCluster.

  • fqdn (str) – The value to assign to the fqdn property of this OpensearchCluster.

  • availability_domains (list[str]) – The value to assign to the availability_domains property of this OpensearchCluster.

  • security_mode (str) – The value to assign to the security_mode property of this OpensearchCluster. Allowed values for this property are: “DISABLED”, “PERMISSIVE”, “ENFORCING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • security_master_user_name (str) – The value to assign to the security_master_user_name property of this OpensearchCluster.

  • security_master_user_password_hash (str) – The value to assign to the security_master_user_password_hash property of this OpensearchCluster.

  • security_saml_config (oci.opensearch.models.SecuritySamlConfig) – The value to assign to the security_saml_config property of this OpensearchCluster.

  • backup_policy (oci.opensearch.models.BackupPolicy) – The value to assign to the backup_policy property of this OpensearchCluster.

  • nsg_id (str) – The value to assign to the nsg_id property of this OpensearchCluster.

  • reverse_connection_endpoint_customer_ips (list[str]) – The value to assign to the reverse_connection_endpoint_customer_ips property of this OpensearchCluster.

  • reverse_connection_endpoints (list[oci.opensearch.models.ReverseConnectionEndpoint]) – The value to assign to the reverse_connection_endpoints property of this OpensearchCluster.

  • outbound_cluster_config (oci.opensearch.models.OutboundClusterConfig) – The value to assign to the outbound_cluster_config property of this OpensearchCluster.

  • inbound_cluster_ids (list[str]) – The value to assign to the inbound_cluster_ids property of this OpensearchCluster.

  • maintenance_details (oci.opensearch.models.MaintenanceDetails) – The value to assign to the maintenance_details property of this OpensearchCluster.

  • load_balancer_config (oci.opensearch.models.LoadBalancerConfig) – The value to assign to the load_balancer_config property of this OpensearchCluster.

  • certificate_config (oci.opensearch.models.CertificateConfig) – The value to assign to the certificate_config property of this OpensearchCluster.

  • remote_reindex_trust_config (oci.opensearch.models.RemoteReindexTrustConfig) – The value to assign to the remote_reindex_trust_config property of this OpensearchCluster.

property availability_domains

[Required] Gets the availability_domains of this OpensearchCluster. The availability domains to distribute the cluser nodes across.

Returns

The availability_domains of this OpensearchCluster.

Return type

list[str]

property backup_policy

Gets the backup_policy of this OpensearchCluster.

Returns

The backup_policy of this OpensearchCluster.

Return type

oci.opensearch.models.BackupPolicy

property certificate_config

Gets the certificate_config of this OpensearchCluster.

Returns

The certificate_config of this OpensearchCluster.

Return type

oci.opensearch.models.CertificateConfig

property compartment_id

[Required] Gets the compartment_id of this OpensearchCluster. The OCID of the compartment where the cluster is located.

Returns

The compartment_id of this OpensearchCluster.

Return type

str

property coordinator_node_count

Gets the coordinator_node_count of this OpensearchCluster. The number of coordinator nodes configured for the cluster.

Returns

The coordinator_node_count of this OpensearchCluster.

Return type

int

property coordinator_node_host_memory_gb

Gets the coordinator_node_host_memory_gb of this OpensearchCluster. The amount of memory in GB, for the cluster’s coordinator nodes.

Returns

The coordinator_node_host_memory_gb of this OpensearchCluster.

Return type

int

property coordinator_node_host_ocpu_count

Gets the coordinator_node_host_ocpu_count of this OpensearchCluster. The number of OCPUs configured for the cluster’s coordinator nodes.

Returns

The coordinator_node_host_ocpu_count of this OpensearchCluster.

Return type

int

property coordinator_node_host_shape

Gets the coordinator_node_host_shape of this OpensearchCluster. The node shape for the cluster’s coordinator nodes.

Returns

The coordinator_node_host_shape of this OpensearchCluster.

Return type

str

property coordinator_node_host_type

Gets the coordinator_node_host_type of this OpensearchCluster. The instance type for the cluster’s coordinator nodes.

Allowed values for this property are: “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The coordinator_node_host_type of this OpensearchCluster.

Return type

str

property data_node_count

[Required] Gets the data_node_count of this OpensearchCluster. The number of data nodes configured for the cluster.

Returns

The data_node_count of this OpensearchCluster.

Return type

int

property data_node_host_bare_metal_shape

Gets the data_node_host_bare_metal_shape of this OpensearchCluster. The bare metal shape for the cluster’s data nodes.

Returns

The data_node_host_bare_metal_shape of this OpensearchCluster.

Return type

str

property data_node_host_memory_gb

[Required] Gets the data_node_host_memory_gb of this OpensearchCluster. The amount of memory in GB, for the cluster’s data nodes.

Returns

The data_node_host_memory_gb of this OpensearchCluster.

Return type

int

property data_node_host_ocpu_count

[Required] Gets the data_node_host_ocpu_count of this OpensearchCluster. The number of OCPUs configured for the cluster’s data nodes.

Returns

The data_node_host_ocpu_count of this OpensearchCluster.

Return type

int

property data_node_host_shape

Gets the data_node_host_shape of this OpensearchCluster. The node shape for the cluster’s data nodes.

Returns

The data_node_host_shape of this OpensearchCluster.

Return type

str

property data_node_host_type

[Required] Gets the data_node_host_type of this OpensearchCluster. The instance type for the cluster’s data nodes.

Allowed values for this property are: “FLEX”, “BM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The data_node_host_type of this OpensearchCluster.

Return type

str

property data_node_storage_gb

[Required] Gets the data_node_storage_gb of this OpensearchCluster. The amount of storage in GB, to configure per node for the cluster’s data nodes.

Returns

The data_node_storage_gb of this OpensearchCluster.

Return type

int

property defined_tags

Gets the defined_tags of this OpensearchCluster. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this OpensearchCluster.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this OpensearchCluster. The name of the cluster. Avoid entering confidential information.

Returns

The display_name of this OpensearchCluster.

Return type

str

property fqdn

Gets the fqdn of this OpensearchCluster. The fully qualified domain name (FQDN) for the cluster’s API endpoint.

Returns

The fqdn of this OpensearchCluster.

Return type

str

property freeform_tags

Gets the freeform_tags of this OpensearchCluster. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this OpensearchCluster.

Return type

dict(str, str)

property id

[Required] Gets the id of this OpensearchCluster. The OCID of the cluster.

Returns

The id of this OpensearchCluster.

Return type

str

property inbound_cluster_ids

Gets the inbound_cluster_ids of this OpensearchCluster. List of inbound clusters for which this cluster is an outbound cluster

Returns

The inbound_cluster_ids of this OpensearchCluster.

Return type

list[str]

property lifecycle_details

Gets the lifecycle_details of this OpensearchCluster. Additional information about the current lifecycle state of the cluster.

Returns

The lifecycle_details of this OpensearchCluster.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this OpensearchCluster. The current state of the cluster.

Allowed values for this property are: “ACTIVE”, “CREATING”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this OpensearchCluster.

Return type

str

property load_balancer_config

Gets the load_balancer_config of this OpensearchCluster.

Returns

The load_balancer_config of this OpensearchCluster.

Return type

oci.opensearch.models.LoadBalancerConfig

property maintenance_details

Gets the maintenance_details of this OpensearchCluster.

Returns

The maintenance_details of this OpensearchCluster.

Return type

oci.opensearch.models.MaintenanceDetails

property master_node_count

[Required] Gets the master_node_count of this OpensearchCluster. The number of master nodes configured for the cluster.

Returns

The master_node_count of this OpensearchCluster.

Return type

int

property master_node_host_bare_metal_shape

Gets the master_node_host_bare_metal_shape of this OpensearchCluster. The bare metal shape for the cluster’s master nodes.

Returns

The master_node_host_bare_metal_shape of this OpensearchCluster.

Return type

str

property master_node_host_memory_gb

[Required] Gets the master_node_host_memory_gb of this OpensearchCluster. The amount of memory in GB, for the cluster’s master nodes.

Returns

The master_node_host_memory_gb of this OpensearchCluster.

Return type

int

property master_node_host_ocpu_count

[Required] Gets the master_node_host_ocpu_count of this OpensearchCluster. The number of OCPUs configured for cluster’s master nodes.

Returns

The master_node_host_ocpu_count of this OpensearchCluster.

Return type

int

property master_node_host_shape

Gets the master_node_host_shape of this OpensearchCluster. The node shape for the cluster’s master nodes.

Returns

The master_node_host_shape of this OpensearchCluster.

Return type

str

property master_node_host_type

[Required] Gets the master_node_host_type of this OpensearchCluster. The instance type for the cluster’s master nodes.

Allowed values for this property are: “FLEX”, “BM”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The master_node_host_type of this OpensearchCluster.

Return type

str

property ml_node_count

Gets the ml_node_count of this OpensearchCluster. The number of ML nodes configured for the cluster.

Returns

The ml_node_count of this OpensearchCluster.

Return type

int

property ml_node_host_memory_gb

Gets the ml_node_host_memory_gb of this OpensearchCluster. The amount of memory in GB, for the cluster’s ML nodes.

Returns

The ml_node_host_memory_gb of this OpensearchCluster.

Return type

int

property ml_node_host_ocpu_count

Gets the ml_node_host_ocpu_count of this OpensearchCluster. The number of OCPUs configured for the cluster’s ML nodes.

Returns

The ml_node_host_ocpu_count of this OpensearchCluster.

Return type

int

property ml_node_host_shape

Gets the ml_node_host_shape of this OpensearchCluster. The node shape for the cluster’s ML nodes.

Returns

The ml_node_host_shape of this OpensearchCluster.

Return type

str

property ml_node_host_type

Gets the ml_node_host_type of this OpensearchCluster. The instance type for the cluster’s ML nodes.

Allowed values for this property are: “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The ml_node_host_type of this OpensearchCluster.

Return type

str

property ml_node_storage_gb

Gets the ml_node_storage_gb of this OpensearchCluster. The amount of storage in GB, to configure per node for the cluster’s ML nodes.

Returns

The ml_node_storage_gb of this OpensearchCluster.

Return type

int

property nsg_id

Gets the nsg_id of this OpensearchCluster. The OCID of the NSG where the private endpoint vnic will be attached.

Returns

The nsg_id of this OpensearchCluster.

Return type

str

property opendashboard_fqdn

[Required] Gets the opendashboard_fqdn of this OpensearchCluster. The fully qualified domain name (FQDN) for the cluster’s OpenSearch Dashboard API endpoint.

Returns

The opendashboard_fqdn of this OpensearchCluster.

Return type

str

property opendashboard_node_count

[Required] Gets the opendashboard_node_count of this OpensearchCluster. The number of OpenSearch Dashboard nodes configured for the cluster.

Returns

The opendashboard_node_count of this OpensearchCluster.

Return type

int

property opendashboard_node_host_memory_gb

[Required] Gets the opendashboard_node_host_memory_gb of this OpensearchCluster. The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.

Returns

The opendashboard_node_host_memory_gb of this OpensearchCluster.

Return type

int

property opendashboard_node_host_ocpu_count

[Required] Gets the opendashboard_node_host_ocpu_count of this OpensearchCluster. The amount of memory in GB, for the cluster’s OpenSearch Dashboard nodes.

Returns

The opendashboard_node_host_ocpu_count of this OpensearchCluster.

Return type

int

property opendashboard_node_host_shape

Gets the opendashboard_node_host_shape of this OpensearchCluster. The node shape for the cluster’s OpenSearch Dashboard nodes.

Returns

The opendashboard_node_host_shape of this OpensearchCluster.

Return type

str

property opendashboard_private_ip

[Required] Gets the opendashboard_private_ip of this OpensearchCluster. The private IP address for the cluster’s OpenSearch Dashboard.

Returns

The opendashboard_private_ip of this OpensearchCluster.

Return type

str

property opensearch_fqdn

[Required] Gets the opensearch_fqdn of this OpensearchCluster. The fully qualified domain name (FQDN) for the cluster’s API endpoint.

Returns

The opensearch_fqdn of this OpensearchCluster.

Return type

str

property opensearch_private_ip

[Required] Gets the opensearch_private_ip of this OpensearchCluster. The cluster’s private IP address.

Returns

The opensearch_private_ip of this OpensearchCluster.

Return type

str

property outbound_cluster_config

Gets the outbound_cluster_config of this OpensearchCluster.

Returns

The outbound_cluster_config of this OpensearchCluster.

Return type

oci.opensearch.models.OutboundClusterConfig

property remote_reindex_trust_config

Gets the remote_reindex_trust_config of this OpensearchCluster.

Returns

The remote_reindex_trust_config of this OpensearchCluster.

Return type

oci.opensearch.models.RemoteReindexTrustConfig

property reverse_connection_endpoint_customer_ips

Gets the reverse_connection_endpoint_customer_ips of this OpensearchCluster. The customer IP addresses of the endpoint in customer VCN

Returns

The reverse_connection_endpoint_customer_ips of this OpensearchCluster.

Return type

list[str]

property reverse_connection_endpoints

Gets the reverse_connection_endpoints of this OpensearchCluster. The list of reverse connection endpoints.

Returns

The reverse_connection_endpoints of this OpensearchCluster.

Return type

list[oci.opensearch.models.ReverseConnectionEndpoint]

property search_node_count

Gets the search_node_count of this OpensearchCluster. The number of search nodes configured for the cluster.

Returns

The search_node_count of this OpensearchCluster.

Return type

int

property search_node_host_memory_gb

Gets the search_node_host_memory_gb of this OpensearchCluster. The amount of memory in GB, for the cluster’s search nodes.

Returns

The search_node_host_memory_gb of this OpensearchCluster.

Return type

int

property search_node_host_ocpu_count

Gets the search_node_host_ocpu_count of this OpensearchCluster. The number of OCPUs configured for the cluster’s search nodes.

Returns

The search_node_host_ocpu_count of this OpensearchCluster.

Return type

int

property search_node_host_shape

Gets the search_node_host_shape of this OpensearchCluster. The node shape for the cluster’s search nodes.

Returns

The search_node_host_shape of this OpensearchCluster.

Return type

str

property search_node_host_type

Gets the search_node_host_type of this OpensearchCluster. The instance type for the cluster’s search nodes.

Allowed values for this property are: “FLEX”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The search_node_host_type of this OpensearchCluster.

Return type

str

property search_node_storage_gb

Gets the search_node_storage_gb of this OpensearchCluster. The amount of storage in GB, to configure per node for the cluster’s search nodes.

Returns

The search_node_storage_gb of this OpensearchCluster.

Return type

int

property security_attributes

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

Example: {“Oracle-ZPR”: {“MaxEgressCount”: {“value”: “42”, “mode”: “enforce”}}}

Returns

The security_attributes of this OpensearchCluster.

Return type

dict(str, dict(str, object))

property security_master_user_name

Gets the security_master_user_name of this OpensearchCluster. The name of the master user that are used to manage security config

Returns

The security_master_user_name of this OpensearchCluster.

Return type

str

property security_master_user_password_hash

Gets the security_master_user_password_hash of this OpensearchCluster. The password hash of the master user that are used to manage security config

Returns

The security_master_user_password_hash of this OpensearchCluster.

Return type

str

property security_mode

Gets the security_mode of this OpensearchCluster. The security mode of the cluster.

Allowed values for this property are: “DISABLED”, “PERMISSIVE”, “ENFORCING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The security_mode of this OpensearchCluster.

Return type

str

property security_saml_config

Gets the security_saml_config of this OpensearchCluster.

Returns

The security_saml_config of this OpensearchCluster.

Return type

oci.opensearch.models.SecuritySamlConfig

property software_version

[Required] Gets the software_version of this OpensearchCluster. The software version the cluster is running.

Returns

The software_version of this OpensearchCluster.

Return type

str

property subnet_compartment_id

[Required] Gets the subnet_compartment_id of this OpensearchCluster. The OCID for the compartment where the cluster’s subnet is located.

Returns

The subnet_compartment_id of this OpensearchCluster.

Return type

str

property subnet_id

[Required] Gets the subnet_id of this OpensearchCluster. The OCID of the cluster’s subnet.

Returns

The subnet_id of this OpensearchCluster.

Return type

str

property system_tags

Gets the system_tags of this OpensearchCluster. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this OpensearchCluster.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this OpensearchCluster. The amount of time in milliseconds since the cluster was created.

Returns

The time_created of this OpensearchCluster.

Return type

datetime

property time_deleted

Gets the time_deleted of this OpensearchCluster. The amount of time in milliseconds since the cluster was updated.

Returns

The time_deleted of this OpensearchCluster.

Return type

datetime

property time_updated

Gets the time_updated of this OpensearchCluster. The amount of time in milliseconds since the cluster was updated.

Returns

The time_updated of this OpensearchCluster.

Return type

datetime

property total_storage_gb

[Required] Gets the total_storage_gb of this OpensearchCluster. The size in GB of the cluster’s total storage.

Returns

The total_storage_gb of this OpensearchCluster.

Return type

int

property vcn_compartment_id

[Required] Gets the vcn_compartment_id of this OpensearchCluster. The OCID for the compartment where the cluster’s VCN is located.

Returns

The vcn_compartment_id of this OpensearchCluster.

Return type

str

property vcn_id

[Required] Gets the vcn_id of this OpensearchCluster. The OCID of the cluster’s VCN.

Returns

The vcn_id of this OpensearchCluster.

Return type

str