resources

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

Overview

Name	resources
Type	Resource
Id	ovh.okms.resources

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	Unique identifier of the OKMS
iam	object	IAM resource metadata
kmip_endpoint	string	KMS kmip API endpoint (wire: kmipEndpoint)
kmip_object_count	integer	Number of KMIP objects (non destroyed) (wire: kmipObjectCount)
kmip_rsa_endpoint	string	KMS kmip RSA API endpoint (wire: kmipRsaEndpoint)
pci_dss_enabled	boolean	Whether PCI-DSS compliance is enabled on the service (wire: pciDssEnabled)
pci_dss_enabled_at	string (date-time)	Tells when PCI-DSS compliance was enabled (wire: pciDssEnabledAt)
public_ca	string	KMS public CA (Certificate Authority) (wire: publicCA)
public_rsa_ca	string	KMS public RSA CA (Certificate Authority) (wire: publicRsaCA)
region	string	Region the key management service runs in, which is where your keys and secrets are stored (ap-south-mum, ap-southeast-sgp, ap-southeast-syd, ca-east-bhs, ca-east-tor, eu-central-waw, eu-south-mil, eu-west-eri, eu-west-gra, eu-west-lim, eu-west-par, eu-west-rbx, eu-west-sbg)
rest_endpoint	string	KMS rest API endpoint (wire: restEndpoint)
secret_count	integer	Number of secrets (wire: secretCount)
secret_version_count	integer	Number of secret versions (wire: secretVersionCount)
service_key_count	integer	Number of service keys (wire: serviceKeyCount)
service_key_count_details	object	Number of service keys per protection level (wire: serviceKeyCountDetails)
swagger_endpoint	string	KMS rest API swagger UI (wire: swaggerEndpoint)

list

An OKMS service

Name	Datatype	Description
id	string (uuid)	Unique identifier of the OKMS
iam	object	IAM resource metadata
kmip_endpoint	string	KMS kmip API endpoint (wire: kmipEndpoint)
kmip_object_count	integer	Number of KMIP objects (non destroyed) (wire: kmipObjectCount)
kmip_rsa_endpoint	string	KMS kmip RSA API endpoint (wire: kmipRsaEndpoint)
pci_dss_enabled	boolean	Whether PCI-DSS compliance is enabled on the service (wire: pciDssEnabled)
pci_dss_enabled_at	string (date-time)	Tells when PCI-DSS compliance was enabled (wire: pciDssEnabledAt)
public_ca	string	KMS public CA (Certificate Authority) (wire: publicCA)
public_rsa_ca	string	KMS public RSA CA (Certificate Authority) (wire: publicRsaCA)
region	string	Region the key management service runs in, which is where your keys and secrets are stored (ap-south-mum, ap-southeast-sgp, ap-southeast-syd, ca-east-bhs, ca-east-tor, eu-central-waw, eu-south-mil, eu-west-eri, eu-west-gra, eu-west-lim, eu-west-par, eu-west-rbx, eu-west-sbg)
rest_endpoint	string	KMS rest API endpoint (wire: restEndpoint)
secret_count	integer	Number of secrets (wire: secretCount)
secret_version_count	integer	Number of secret versions (wire: secretVersionCount)
service_key_count	integer	Number of service keys (wire: serviceKeyCount)
service_key_count_details	object	Number of service keys per protection level (wire: serviceKeyCountDetails)
swagger_endpoint	string	KMS rest API swagger UI (wire: swaggerEndpoint)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	okms_id	public_ca	Returns the OKMS service with its endpoints and resource counts. Set publicCA to true to include the KMS public CA certificate.
list	select		x_pagination_cursor, x_pagination_size, iam_tags	Returns the OKMS services of the account, with their region, KMIP and REST endpoints, and counts of keys, secrets and KMIP objects.
update	update	okms_id		Enables or disables PCI-DSS enforcement on the service.
log_url	exec	okmsId, kind		Returns a temporary signed URL for read-only access to the logs of the given kind. The link expires. (Beta version)

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.

Name	Datatype	Description
api_host	string	The 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"}})
okmsId	string (uuid)	Okms ID
okms_id	string (uuid)	Okms ID (wire: okmsId)
iam_tags	object	Filter resources on IAM tags (wire: iamTags)
public_ca	boolean	Add KMS public CA (Certificate Authority) in the output (wire: publicCA)
x_pagination_cursor	string	Pagination cursor (wire: X-Pagination-Cursor)
x_pagination_size	integer	Pagination size (wire: X-Pagination-Size)

SELECT examples

get

Returns the OKMS service with its endpoints and resource counts. Set publicCA to true to include the KMS public CA certificate.

SELECT
id,
iam,
kmip_endpoint,
kmip_object_count,
kmip_rsa_endpoint,
pci_dss_enabled,
pci_dss_enabled_at,
public_ca,
public_rsa_ca,
region,
rest_endpoint,
secret_count,
secret_version_count,
service_key_count,
service_key_count_details,
swagger_endpoint
FROM ovh.okms.resources
WHERE okms_id = '{{ okms_id }}' -- required
AND public_ca = '{{ public_ca }}'
;

list

Returns the OKMS services of the account, with their region, KMIP and REST endpoints, and counts of keys, secrets and KMIP objects.

SELECT
id,
iam,
kmip_endpoint,
kmip_object_count,
kmip_rsa_endpoint,
pci_dss_enabled,
pci_dss_enabled_at,
public_ca,
public_rsa_ca,
region,
rest_endpoint,
secret_count,
secret_version_count,
service_key_count,
service_key_count_details,
swagger_endpoint
FROM ovh.okms.resources
WHERE x_pagination_cursor = '{{ x_pagination_cursor }}'
AND x_pagination_size = '{{ x_pagination_size }}'
AND iam_tags = '{{ iam_tags }}'
;

UPDATE examples

update

Enables or disables PCI-DSS enforcement on the service.

UPDATE ovh.okms.resources
SET 
pci_dss_enabled = {{ pci_dss_enabled }}
WHERE 
okms_id = '{{ okms_id }}' --required
RETURNING
id,
kmip_endpoint,
kmip_object_count,
kmip_rsa_endpoint,
pci_dss_enabled,
pci_dss_enabled_at,
public_ca,
public_rsa_ca,
region,
rest_endpoint,
secret_count,
secret_version_count,
service_key_count,
service_key_count_details,
swagger_endpoint;

Lifecycle Methods

EXEC variables use wire (API) names.

log_url

Returns a temporary signed URL for read-only access to the logs of the given kind. The link expires. (Beta version)

EXEC ovh.okms.resources.log_url 
@okmsId='{{ okmsId }}' --required 
@@json=
'{
"kind": "{{ kind }}"
}'
;