OpensearchClusterSummary

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

Bases: object

The summary of information about an OpenSearch cluster.

Attributes:

SECURITY_MODE_DISABLED

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

SECURITY_MODE_ENFORCING

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

SECURITY_MODE_PERMISSIVE

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

availability_domains

Gets the availability_domains of this OpensearchClusterSummary.

backup_policy

Gets the backup_policy of this OpensearchClusterSummary.

compartment_id

[Required] Gets the compartment_id of this OpensearchClusterSummary.

defined_tags

Gets the defined_tags of this OpensearchClusterSummary.

display_name

Gets the display_name of this OpensearchClusterSummary.

freeform_tags

Gets the freeform_tags of this OpensearchClusterSummary.

id

[Required] Gets the id of this OpensearchClusterSummary.

lifecycle_details

Gets the lifecycle_details of this OpensearchClusterSummary.

lifecycle_state

Gets the lifecycle_state of this OpensearchClusterSummary.

load_balancer_config

Gets the load_balancer_config of this OpensearchClusterSummary.

outbound_cluster_config

Gets the outbound_cluster_config of this OpensearchClusterSummary.

remote_reindex_trust_config

Gets the remote_reindex_trust_config of this OpensearchClusterSummary.

security_attributes

Gets the security_attributes of this OpensearchClusterSummary.

security_mode

Gets the security_mode of this OpensearchClusterSummary.

software_version

[Required] Gets the software_version of this OpensearchClusterSummary.

system_tags

Gets the system_tags of this OpensearchClusterSummary.

time_created

Gets the time_created of this OpensearchClusterSummary.

time_updated

Gets the time_updated of this OpensearchClusterSummary.

total_storage_gb

[Required] Gets the total_storage_gb of this OpensearchClusterSummary.

Methods:

__init__(**kwargs)

Initializes a new OpensearchClusterSummary object with values from keyword arguments.

SECURITY_MODE_DISABLED = 'DISABLED'

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

SECURITY_MODE_ENFORCING = 'ENFORCING'

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

SECURITY_MODE_PERMISSIVE = 'PERMISSIVE'

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

__init__(**kwargs)

Initializes a new OpensearchClusterSummary 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 OpensearchClusterSummary.

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

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

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

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

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

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

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

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this OpensearchClusterSummary.

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

  • security_mode (str) – The value to assign to the security_mode property of this OpensearchClusterSummary. 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’.

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

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

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

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

property availability_domains

Gets the availability_domains of this OpensearchClusterSummary. The availability domains to distribute the cluser nodes across.

Returns

The availability_domains of this OpensearchClusterSummary.

Return type

list[str]

property backup_policy

Gets the backup_policy of this OpensearchClusterSummary.

Returns

The backup_policy of this OpensearchClusterSummary.

Return type

oci.opensearch.models.BackupPolicy

property compartment_id

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

Returns

The compartment_id of this OpensearchClusterSummary.

Return type

str

property defined_tags

Gets the defined_tags of this OpensearchClusterSummary. 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 OpensearchClusterSummary.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this OpensearchClusterSummary. The name of the cluster. Avoid entering confidential information.

Returns

The display_name of this OpensearchClusterSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this OpensearchClusterSummary. 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 OpensearchClusterSummary.

Return type

dict(str, str)

property id

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

Returns

The id of this OpensearchClusterSummary.

Return type

str

property lifecycle_details

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

Returns

The lifecycle_details of this OpensearchClusterSummary.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this OpensearchClusterSummary. The current state of the cluster.

Returns

The lifecycle_state of this OpensearchClusterSummary.

Return type

str

property load_balancer_config

Gets the load_balancer_config of this OpensearchClusterSummary.

Returns

The load_balancer_config of this OpensearchClusterSummary.

Return type

oci.opensearch.models.LoadBalancerConfig

property outbound_cluster_config

Gets the outbound_cluster_config of this OpensearchClusterSummary.

Returns

The outbound_cluster_config of this OpensearchClusterSummary.

Return type

oci.opensearch.models.OutboundClusterConfig

property remote_reindex_trust_config

Gets the remote_reindex_trust_config of this OpensearchClusterSummary.

Returns

The remote_reindex_trust_config of this OpensearchClusterSummary.

Return type

oci.opensearch.models.RemoteReindexTrustConfig

property security_attributes

Gets the security_attributes of this OpensearchClusterSummary. 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 OpensearchClusterSummary.

Return type

dict(str, dict(str, object))

property security_mode

Gets the security_mode of this OpensearchClusterSummary. 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 OpensearchClusterSummary.

Return type

str

property software_version

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

Returns

The software_version of this OpensearchClusterSummary.

Return type

str

property system_tags

Gets the system_tags of this OpensearchClusterSummary. 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 OpensearchClusterSummary.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this OpensearchClusterSummary. The date and time the cluster was created. Format defined by RFC3339.

Returns

The time_created of this OpensearchClusterSummary.

Return type

datetime

property time_updated

Gets the time_updated of this OpensearchClusterSummary. The date and time the cluster was updated. Format defined by RFC3339.

Returns

The time_updated of this OpensearchClusterSummary.

Return type

datetime

property total_storage_gb

[Required] Gets the total_storage_gb of this OpensearchClusterSummary. The total amount of storage in GB, for the cluster.

Returns

The total_storage_gb of this OpensearchClusterSummary.

Return type

int