Skip to main content

opensearch_capabilities_advanced_configurations

Creates, updates, deletes, gets or lists an opensearch_capabilities_advanced_configurations resource.

Overview​

Nameopensearch_capabilities_advanced_configurations
TypeResource
Idovh.cloud_database.opensearch_capabilities_advanced_configurations

Fields​

The following fields are returned by SELECT queries:

Specific database engine capability

NameDatatypeDescription
namestringProperty name
defaultstringDefault value of the property. Null when the engine does not provide one.
descriptionstringDescription of the property
maximumnumberMaximum value for the property if numeric and applicable
minimumnumberMinimum value for the property if numeric and applicable
typestringData type of the property (boolean, double, long, string)
valuesarrayPossible values for the property if string and applicable

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectcluster_id, service_nameGet opensearch advanced configuration fields

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
cluster_idstring (uuid)Cluster ID (wire: clusterId)
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples​

Get opensearch advanced configuration fields

SELECT
name,
default,
description,
maximum,
minimum,
type,
values
FROM ovh.cloud_database.opensearch_capabilities_advanced_configurations
WHERE cluster_id = '{{ cluster_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;