CertificateConfig¶

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

Bases: object

Custom certificate config for customer provided certs.

Attributes

`CLUSTER_CERTIFICATE_MODE_OCI_CERTIFICATES_SERVICE`	A constant which can be used with the cluster_certificate_mode property of a CertificateConfig.
`CLUSTER_CERTIFICATE_MODE_OPENSEARCH_SERVICE`	A constant which can be used with the cluster_certificate_mode property of a CertificateConfig.
`DASHBOARD_CERTIFICATE_MODE_OCI_CERTIFICATES_SERVICE`	A constant which can be used with the dashboard_certificate_mode property of a CertificateConfig.
`DASHBOARD_CERTIFICATE_MODE_OPENSEARCH_SERVICE`	A constant which can be used with the dashboard_certificate_mode property of a CertificateConfig.
`cluster_certificate_mode`	Gets the cluster_certificate_mode of this CertificateConfig.
`dashboard_certificate_mode`	Gets the dashboard_certificate_mode of this CertificateConfig.
`open_search_api_certificate_id`	Gets the open_search_api_certificate_id of this CertificateConfig.
`open_search_dashboard_certificate_id`	Gets the open_search_dashboard_certificate_id of this CertificateConfig.

Methods

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

CLUSTER_CERTIFICATE_MODE_OCI_CERTIFICATES_SERVICE = 'OCI_CERTIFICATES_SERVICE'¶: A constant which can be used with the cluster_certificate_mode property of a CertificateConfig. This constant has a value of “OCI_CERTIFICATES_SERVICE”

CLUSTER_CERTIFICATE_MODE_OPENSEARCH_SERVICE = 'OPENSEARCH_SERVICE'¶: A constant which can be used with the cluster_certificate_mode property of a CertificateConfig. This constant has a value of “OPENSEARCH_SERVICE”

DASHBOARD_CERTIFICATE_MODE_OCI_CERTIFICATES_SERVICE = 'OCI_CERTIFICATES_SERVICE'¶: A constant which can be used with the dashboard_certificate_mode property of a CertificateConfig. This constant has a value of “OCI_CERTIFICATES_SERVICE”

DASHBOARD_CERTIFICATE_MODE_OPENSEARCH_SERVICE = 'OPENSEARCH_SERVICE'¶: A constant which can be used with the dashboard_certificate_mode property of a CertificateConfig. This constant has a value of “OPENSEARCH_SERVICE”

__init__(**kwargs)¶

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

Parameters:

cluster_certificate_mode (str) – The value to assign to the cluster_certificate_mode property of this CertificateConfig. Allowed values for this property are: “OCI_CERTIFICATES_SERVICE”, “OPENSEARCH_SERVICE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
dashboard_certificate_mode (str) – The value to assign to the dashboard_certificate_mode property of this CertificateConfig. Allowed values for this property are: “OCI_CERTIFICATES_SERVICE”, “OPENSEARCH_SERVICE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
open_search_api_certificate_id (str) – The value to assign to the open_search_api_certificate_id property of this CertificateConfig.
open_search_dashboard_certificate_id (str) – The value to assign to the open_search_dashboard_certificate_id property of this CertificateConfig.

cluster_certificate_mode¶

Gets the cluster_certificate_mode of this CertificateConfig. Specifies whether the certificate to be used in cluster is managed by OpenSearch or OCI Certificates service.

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

Returns:	The cluster_certificate_mode of this CertificateConfig.
Return type:	str

dashboard_certificate_mode¶

Gets the dashboard_certificate_mode of this CertificateConfig. Specifies whether the certificate to be used in dashboard is managed by OpenSearch or OCI Certificates service.

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

Returns:	The dashboard_certificate_mode of this CertificateConfig.
Return type:	str

open_search_api_certificate_id¶

Gets the open_search_api_certificate_id of this CertificateConfig. certificate to be used for OpenSearch cluster api communication

Returns:	The open_search_api_certificate_id of this CertificateConfig.
Return type:	str

open_search_dashboard_certificate_id¶

Gets the open_search_dashboard_certificate_id of this CertificateConfig. certificate to be used for OpenSearch dashboard api communication

Returns:	The open_search_dashboard_certificate_id of this CertificateConfig.
Return type:	str