Skip to main content

resource_secret_configs

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

Overview​

Nameresource_secret_configs
TypeResource
Idovh.okms.resource_secret_configs

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
cas_requiredbooleanIf set to true, the Cas (Check And Set) parameter will be required and verified for each secret update (wire: casRequired)
deactivate_version_afterstringTime duration before a version is deactivated. If 0s, default configuration (unlimited) is applied. (wire: deactivateVersionAfter)
max_versionsintegerThe number of versions to keep. If 0, default configuration (10) is applied. (wire: maxVersions)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectokms_idReturns the service-level defaults applied to new secrets: casRequired, maxVersions and deactivateVersionAfter.
updateupdateokms_idUpdates the service-level defaults applied to new secrets.<br />Existing secrets keep the metadata they were created with.

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"}})
okms_idstring (uuid)Okms ID (wire: okmsId)

SELECT examples​

Returns the service-level defaults applied to new secrets: casRequired, maxVersions and deactivateVersionAfter.

SELECT
cas_required,
deactivate_version_after,
max_versions
FROM ovh.okms.resource_secret_configs
WHERE okms_id = '{{ okms_id }}' -- required
;

UPDATE examples​

Updates the service-level defaults applied to new secrets.<br />Existing secrets keep the metadata they were created with.

UPDATE ovh.okms.resource_secret_configs
SET
cas_required = {{ cas_required }},
deactivate_version_after = '{{ deactivate_version_after }}',
max_versions = {{ max_versions }}
WHERE
okms_id = '{{ okms_id }}' --required
RETURNING
cas_required,
deactivate_version_after,
max_versions;