CreateOpensearchClusterDetails¶

class oci.opensearch.models.CreateOpensearchClusterDetails(**kwargs)¶

Bases: object

The configuration details for a new OpenSearch cluster.

Attributes

`DATA_NODE_HOST_TYPE_BM`	A constant which can be used with the data_node_host_type property of a CreateOpensearchClusterDetails.
`DATA_NODE_HOST_TYPE_FLEX`	A constant which can be used with the data_node_host_type property of a CreateOpensearchClusterDetails.
`MASTER_NODE_HOST_TYPE_BM`	A constant which can be used with the master_node_host_type property of a CreateOpensearchClusterDetails.
`MASTER_NODE_HOST_TYPE_FLEX`	A constant which can be used with the master_node_host_type property of a CreateOpensearchClusterDetails.
`SECURITY_MODE_DISABLED`	A constant which can be used with the security_mode property of a CreateOpensearchClusterDetails.
`SECURITY_MODE_ENFORCING`	A constant which can be used with the security_mode property of a CreateOpensearchClusterDetails.
`SECURITY_MODE_PERMISSIVE`	A constant which can be used with the security_mode property of a CreateOpensearchClusterDetails.
`backup_policy`	Gets the backup_policy of this CreateOpensearchClusterDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateOpensearchClusterDetails.
`data_node_count`	[Required] Gets the data_node_count of this CreateOpensearchClusterDetails.
`data_node_host_bare_metal_shape`	Gets the data_node_host_bare_metal_shape of this CreateOpensearchClusterDetails.
`data_node_host_memory_gb`	[Required] Gets the data_node_host_memory_gb of this CreateOpensearchClusterDetails.
`data_node_host_ocpu_count`	[Required] Gets the data_node_host_ocpu_count of this CreateOpensearchClusterDetails.
`data_node_host_type`	[Required] Gets the data_node_host_type of this CreateOpensearchClusterDetails.
`data_node_storage_gb`	[Required] Gets the data_node_storage_gb of this CreateOpensearchClusterDetails.
`defined_tags`	Gets the defined_tags of this CreateOpensearchClusterDetails.
`display_name`	[Required] Gets the display_name of this CreateOpensearchClusterDetails.
`freeform_tags`	Gets the freeform_tags of this CreateOpensearchClusterDetails.
`inbound_cluster_ids`	Gets the inbound_cluster_ids of this CreateOpensearchClusterDetails.
`maintenance_details`	Gets the maintenance_details of this CreateOpensearchClusterDetails.
`master_node_count`	[Required] Gets the master_node_count of this CreateOpensearchClusterDetails.
`master_node_host_bare_metal_shape`	Gets the master_node_host_bare_metal_shape of this CreateOpensearchClusterDetails.
`master_node_host_memory_gb`	[Required] Gets the master_node_host_memory_gb of this CreateOpensearchClusterDetails.
`master_node_host_ocpu_count`	[Required] Gets the master_node_host_ocpu_count of this CreateOpensearchClusterDetails.
`master_node_host_type`	[Required] Gets the master_node_host_type of this CreateOpensearchClusterDetails.
`opendashboard_node_count`	[Required] Gets the opendashboard_node_count of this CreateOpensearchClusterDetails.
`opendashboard_node_host_memory_gb`	[Required] Gets the opendashboard_node_host_memory_gb of this CreateOpensearchClusterDetails.
`opendashboard_node_host_ocpu_count`	[Required] Gets the opendashboard_node_host_ocpu_count of this CreateOpensearchClusterDetails.
`outbound_cluster_config`	Gets the outbound_cluster_config of this CreateOpensearchClusterDetails.
`reverse_connection_endpoint_customer_ips`	Gets the reverse_connection_endpoint_customer_ips of this CreateOpensearchClusterDetails.
`security_master_user_name`	Gets the security_master_user_name of this CreateOpensearchClusterDetails.
`security_master_user_password_hash`	Gets the security_master_user_password_hash of this CreateOpensearchClusterDetails.
`security_mode`	Gets the security_mode of this CreateOpensearchClusterDetails.
`security_saml_config`	Gets the security_saml_config of this CreateOpensearchClusterDetails.
`software_version`	[Required] Gets the software_version of this CreateOpensearchClusterDetails.
`subnet_compartment_id`	[Required] Gets the subnet_compartment_id of this CreateOpensearchClusterDetails.
`subnet_id`	[Required] Gets the subnet_id of this CreateOpensearchClusterDetails.
`system_tags`	Gets the system_tags of this CreateOpensearchClusterDetails.
`vcn_compartment_id`	[Required] Gets the vcn_compartment_id of this CreateOpensearchClusterDetails.
`vcn_id`	[Required] Gets the vcn_id of this CreateOpensearchClusterDetails.

Methods

__init__(**kwargs) Initializes a new CreateOpensearchClusterDetails object with values from keyword arguments.

DATA_NODE_HOST_TYPE_BM = 'BM'¶: A constant which can be used with the data_node_host_type property of a CreateOpensearchClusterDetails. 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 CreateOpensearchClusterDetails. This constant has a value of “FLEX”

MASTER_NODE_HOST_TYPE_BM = 'BM'¶: A constant which can be used with the master_node_host_type property of a CreateOpensearchClusterDetails. 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 CreateOpensearchClusterDetails. This constant has a value of “FLEX”

SECURITY_MODE_DISABLED = 'DISABLED'¶: A constant which can be used with the security_mode property of a CreateOpensearchClusterDetails. This constant has a value of “DISABLED”

SECURITY_MODE_ENFORCING = 'ENFORCING'¶: A constant which can be used with the security_mode property of a CreateOpensearchClusterDetails. This constant has a value of “ENFORCING”

SECURITY_MODE_PERMISSIVE = 'PERMISSIVE'¶: A constant which can be used with the security_mode property of a CreateOpensearchClusterDetails. This constant has a value of “PERMISSIVE”

__init__(**kwargs)¶

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

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateOpensearchClusterDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateOpensearchClusterDetails.
software_version (str) – The value to assign to the software_version property of this CreateOpensearchClusterDetails.
master_node_count (int) – The value to assign to the master_node_count property of this CreateOpensearchClusterDetails.
master_node_host_type (str) – The value to assign to the master_node_host_type property of this CreateOpensearchClusterDetails. Allowed values for this property are: “FLEX”, “BM”
master_node_host_bare_metal_shape (str) – The value to assign to the master_node_host_bare_metal_shape property of this CreateOpensearchClusterDetails.
master_node_host_ocpu_count (int) – The value to assign to the master_node_host_ocpu_count property of this CreateOpensearchClusterDetails.
master_node_host_memory_gb (int) – The value to assign to the master_node_host_memory_gb property of this CreateOpensearchClusterDetails.
data_node_count (int) – The value to assign to the data_node_count property of this CreateOpensearchClusterDetails.
data_node_host_type (str) – The value to assign to the data_node_host_type property of this CreateOpensearchClusterDetails. Allowed values for this property are: “FLEX”, “BM”
data_node_host_bare_metal_shape (str) – The value to assign to the data_node_host_bare_metal_shape property of this CreateOpensearchClusterDetails.
data_node_host_ocpu_count (int) – The value to assign to the data_node_host_ocpu_count property of this CreateOpensearchClusterDetails.
data_node_host_memory_gb (int) – The value to assign to the data_node_host_memory_gb property of this CreateOpensearchClusterDetails.
data_node_storage_gb (int) – The value to assign to the data_node_storage_gb property of this CreateOpensearchClusterDetails.
opendashboard_node_count (int) – The value to assign to the opendashboard_node_count property of this CreateOpensearchClusterDetails.
opendashboard_node_host_ocpu_count (int) – The value to assign to the opendashboard_node_host_ocpu_count property of this CreateOpensearchClusterDetails.
opendashboard_node_host_memory_gb (int) – The value to assign to the opendashboard_node_host_memory_gb property of this CreateOpensearchClusterDetails.
vcn_id (str) – The value to assign to the vcn_id property of this CreateOpensearchClusterDetails.
subnet_id (str) – The value to assign to the subnet_id property of this CreateOpensearchClusterDetails.
vcn_compartment_id (str) – The value to assign to the vcn_compartment_id property of this CreateOpensearchClusterDetails.
subnet_compartment_id (str) – The value to assign to the subnet_compartment_id property of this CreateOpensearchClusterDetails.
security_mode (str) – The value to assign to the security_mode property of this CreateOpensearchClusterDetails. Allowed values for this property are: “DISABLED”, “PERMISSIVE”, “ENFORCING”
security_master_user_name (str) – The value to assign to the security_master_user_name property of this CreateOpensearchClusterDetails.
security_master_user_password_hash (str) – The value to assign to the security_master_user_password_hash property of this CreateOpensearchClusterDetails.
security_saml_config (oci.opensearch.models.SecuritySamlConfig) – The value to assign to the security_saml_config property of this CreateOpensearchClusterDetails.
backup_policy (oci.opensearch.models.BackupPolicy) – The value to assign to the backup_policy property of this CreateOpensearchClusterDetails.
reverse_connection_endpoint_customer_ips (list[str]) – The value to assign to the reverse_connection_endpoint_customer_ips property of this CreateOpensearchClusterDetails.
inbound_cluster_ids (list[str]) – The value to assign to the inbound_cluster_ids property of this CreateOpensearchClusterDetails.
outbound_cluster_config (oci.opensearch.models.OutboundClusterConfig) – The value to assign to the outbound_cluster_config property of this CreateOpensearchClusterDetails.
maintenance_details (oci.opensearch.models.CreateMaintenanceDetails) – The value to assign to the maintenance_details property of this CreateOpensearchClusterDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOpensearchClusterDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOpensearchClusterDetails.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this CreateOpensearchClusterDetails.

backup_policy¶

Gets the backup_policy of this CreateOpensearchClusterDetails.

Returns:	The backup_policy of this CreateOpensearchClusterDetails.
Return type:	oci.opensearch.models.BackupPolicy

compartment_id¶

[Required] Gets the compartment_id of this CreateOpensearchClusterDetails. The OCID of the compartment to create the cluster in.

Returns:	The compartment_id of this CreateOpensearchClusterDetails.
Return type:	str

data_node_count¶

[Required] Gets the data_node_count of this CreateOpensearchClusterDetails. The number of data nodes to configure for the cluster.

Returns:	The data_node_count of this CreateOpensearchClusterDetails.
Return type:	int

data_node_host_bare_metal_shape¶

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

Returns:	The data_node_host_bare_metal_shape of this CreateOpensearchClusterDetails.
Return type:	str

data_node_host_memory_gb¶

[Required] Gets the data_node_host_memory_gb of this CreateOpensearchClusterDetails. The amount of memory in GB, to configure per node for the cluster’s data nodes.

Returns:	The data_node_host_memory_gb of this CreateOpensearchClusterDetails.
Return type:	int

data_node_host_ocpu_count¶

[Required] Gets the data_node_host_ocpu_count of this CreateOpensearchClusterDetails. The number of OCPUs to configure for the cluster’s data nodes.

Returns:	The data_node_host_ocpu_count of this CreateOpensearchClusterDetails.
Return type:	int

data_node_host_type¶

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

Allowed values for this property are: “FLEX”, “BM”

Returns:	The data_node_host_type of this CreateOpensearchClusterDetails.
Return type:	str

data_node_storage_gb¶

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

Returns:	The data_node_storage_gb of this CreateOpensearchClusterDetails.
Return type:	int

defined_tags¶

Gets the defined_tags of this CreateOpensearchClusterDetails. 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 CreateOpensearchClusterDetails.
Return type:	dict(str, dict(str, object))

display_name¶

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

Returns:	The display_name of this CreateOpensearchClusterDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateOpensearchClusterDetails. 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 CreateOpensearchClusterDetails.
Return type:	dict(str, str)

inbound_cluster_ids¶

Gets the inbound_cluster_ids of this CreateOpensearchClusterDetails. List of inbound clusters that will be queried using cross cluster search

Returns:	The inbound_cluster_ids of this CreateOpensearchClusterDetails.
Return type:	list[str]

maintenance_details¶

Gets the maintenance_details of this CreateOpensearchClusterDetails.

Returns:	The maintenance_details of this CreateOpensearchClusterDetails.
Return type:	oci.opensearch.models.CreateMaintenanceDetails

master_node_count¶

[Required] Gets the master_node_count of this CreateOpensearchClusterDetails. The number of master nodes to configure for the cluster.

Returns:	The master_node_count of this CreateOpensearchClusterDetails.
Return type:	int

master_node_host_bare_metal_shape¶

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

Returns:	The master_node_host_bare_metal_shape of this CreateOpensearchClusterDetails.
Return type:	str

master_node_host_memory_gb¶

[Required] Gets the master_node_host_memory_gb of this CreateOpensearchClusterDetails. The amount of memory in GB, to configure per node for the cluster’s master nodes.

Returns:	The master_node_host_memory_gb of this CreateOpensearchClusterDetails.
Return type:	int

master_node_host_ocpu_count¶

[Required] Gets the master_node_host_ocpu_count of this CreateOpensearchClusterDetails. The number of OCPUs to configure for the cluser’s master nodes.

Returns:	The master_node_host_ocpu_count of this CreateOpensearchClusterDetails.
Return type:	int

master_node_host_type¶

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

Allowed values for this property are: “FLEX”, “BM”

Returns:	The master_node_host_type of this CreateOpensearchClusterDetails.
Return type:	str

opendashboard_node_count¶

[Required] Gets the opendashboard_node_count of this CreateOpensearchClusterDetails. The number of OpenSearch Dashboard nodes to configure for the cluster.

Returns:	The opendashboard_node_count of this CreateOpensearchClusterDetails.
Return type:	int

opendashboard_node_host_memory_gb¶

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

Returns:	The opendashboard_node_host_memory_gb of this CreateOpensearchClusterDetails.
Return type:	int

opendashboard_node_host_ocpu_count¶

[Required] Gets the opendashboard_node_host_ocpu_count of this CreateOpensearchClusterDetails. The number of OCPUs to configure for the cluster’s OpenSearch Dashboard nodes.

Returns:	The opendashboard_node_host_ocpu_count of this CreateOpensearchClusterDetails.
Return type:	int

outbound_cluster_config¶

Gets the outbound_cluster_config of this CreateOpensearchClusterDetails.

Returns:	The outbound_cluster_config of this CreateOpensearchClusterDetails.
Return type:	oci.opensearch.models.OutboundClusterConfig

reverse_connection_endpoint_customer_ips¶

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

Returns:	The reverse_connection_endpoint_customer_ips of this CreateOpensearchClusterDetails.
Return type:	list[str]

security_master_user_name¶

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

Returns:	The security_master_user_name of this CreateOpensearchClusterDetails.
Return type:	str

security_master_user_password_hash¶

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

Returns:	The security_master_user_password_hash of this CreateOpensearchClusterDetails.
Return type:	str

security_mode¶

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

Allowed values for this property are: “DISABLED”, “PERMISSIVE”, “ENFORCING”

Returns:	The security_mode of this CreateOpensearchClusterDetails.
Return type:	str

security_saml_config¶

Gets the security_saml_config of this CreateOpensearchClusterDetails.

Returns:	The security_saml_config of this CreateOpensearchClusterDetails.
Return type:	oci.opensearch.models.SecuritySamlConfig

software_version¶

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

Returns:	The software_version of this CreateOpensearchClusterDetails.
Return type:	str

subnet_compartment_id¶

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

Returns:	The subnet_compartment_id of this CreateOpensearchClusterDetails.
Return type:	str

subnet_id¶

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

Returns:	The subnet_id of this CreateOpensearchClusterDetails.
Return type:	str

system_tags¶

Gets the system_tags of this CreateOpensearchClusterDetails. 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 CreateOpensearchClusterDetails.
Return type:	dict(str, dict(str, object))

vcn_compartment_id¶

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

Returns:	The vcn_compartment_id of this CreateOpensearchClusterDetails.
Return type:	str

vcn_id¶

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

Returns:	The vcn_id of this CreateOpensearchClusterDetails.
Return type:	str