UpdateOpensearchClusterDetails¶

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

Bases: object

The configuration to update on an existing OpenSearch cluster. Software version and security config are not allowed to be updated at the same time.

Attributes

`SECURITY_MODE_DISABLED`	A constant which can be used with the security_mode property of a UpdateOpensearchClusterDetails.
`SECURITY_MODE_ENFORCING`	A constant which can be used with the security_mode property of a UpdateOpensearchClusterDetails.
`SECURITY_MODE_PERMISSIVE`	A constant which can be used with the security_mode property of a UpdateOpensearchClusterDetails.
`backup_policy`	Gets the backup_policy of this UpdateOpensearchClusterDetails.
`defined_tags`	Gets the defined_tags of this UpdateOpensearchClusterDetails.
`display_name`	[Required] Gets the display_name of this UpdateOpensearchClusterDetails.
`freeform_tags`	Gets the freeform_tags of this UpdateOpensearchClusterDetails.
`maintenance_details`	Gets the maintenance_details of this UpdateOpensearchClusterDetails.
`outbound_cluster_config`	Gets the outbound_cluster_config of this UpdateOpensearchClusterDetails.
`reverse_connection_endpoint_customer_ips`	Gets the reverse_connection_endpoint_customer_ips of this UpdateOpensearchClusterDetails.
`security_master_user_name`	Gets the security_master_user_name of this UpdateOpensearchClusterDetails.
`security_master_user_password_hash`	Gets the security_master_user_password_hash of this UpdateOpensearchClusterDetails.
`security_mode`	Gets the security_mode of this UpdateOpensearchClusterDetails.
`security_saml_config`	Gets the security_saml_config of this UpdateOpensearchClusterDetails.
`software_version`	Gets the software_version of this UpdateOpensearchClusterDetails.

Methods

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

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

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

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

__init__(**kwargs)¶

Initializes a new UpdateOpensearchClusterDetails 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 UpdateOpensearchClusterDetails.
software_version (str) – The value to assign to the software_version property of this UpdateOpensearchClusterDetails.
security_mode (str) – The value to assign to the security_mode property of this UpdateOpensearchClusterDetails. 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 UpdateOpensearchClusterDetails.
security_master_user_password_hash (str) – The value to assign to the security_master_user_password_hash property of this UpdateOpensearchClusterDetails.
security_saml_config (oci.opensearch.models.SecuritySamlConfig) – The value to assign to the security_saml_config property of this UpdateOpensearchClusterDetails.
backup_policy (oci.opensearch.models.BackupPolicy) – The value to assign to the backup_policy property of this UpdateOpensearchClusterDetails.
reverse_connection_endpoint_customer_ips (list[str]) – The value to assign to the reverse_connection_endpoint_customer_ips property of this UpdateOpensearchClusterDetails.
outbound_cluster_config (oci.opensearch.models.OutboundClusterConfig) – The value to assign to the outbound_cluster_config property of this UpdateOpensearchClusterDetails.
maintenance_details (oci.opensearch.models.UpdateMaintenanceDetails) – The value to assign to the maintenance_details property of this UpdateOpensearchClusterDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UpdateOpensearchClusterDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UpdateOpensearchClusterDetails.

backup_policy¶

Gets the backup_policy of this UpdateOpensearchClusterDetails.

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

defined_tags¶

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

display_name¶

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

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

freeform_tags¶

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

maintenance_details¶

Gets the maintenance_details of this UpdateOpensearchClusterDetails.

Returns:	The maintenance_details of this UpdateOpensearchClusterDetails.
Return type:	oci.opensearch.models.UpdateMaintenanceDetails

outbound_cluster_config¶

Gets the outbound_cluster_config of this UpdateOpensearchClusterDetails.

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

reverse_connection_endpoint_customer_ips¶

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

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

security_master_user_name¶

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

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

security_master_user_password_hash¶

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

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

security_mode¶

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

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

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

security_saml_config¶

Gets the security_saml_config of this UpdateOpensearchClusterDetails.

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

software_version¶

Gets the software_version of this UpdateOpensearchClusterDetails.

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