Skip to main content

reference_secret_configs

Creates, updates, deletes, gets or lists a reference_secret_configs resource.

Overview​

Namereference_secret_configs
TypeResource
Idovh.okms.reference_secret_configs

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
cas_requiredbooleanThe cas parameter will be required for all write requests if set to true (wire: casRequired)
max_versionsintegerThe number of versions to keep (wire: maxVersions)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectregionReturns the default secret settings of a region: whether cas is required and the number of versions to keep.

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"}})
regionstringOKMS Region

SELECT examples​

Returns the default secret settings of a region: whether cas is required and the number of versions to keep.

SELECT
cas_required,
max_versions
FROM ovh.okms.reference_secret_configs
WHERE region = '{{ region }}' -- required
;