encryption_keys

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

Overview

Name	encryption_keys
Type	Resource
Id	ovh.dbaas_logs.encryption_keys

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
encryption_key_id	string (uuid)	Encryption Key ID (wire: encryptionKeyId)
algorithm	string	Encryption Key algorithm (ECC25519, RSA4096)
content	string (password)	Encryption Key content
created_at	string (date-time)	Encryption Key creation date (wire: createdAt)
fingerprint	string	Encryption Key fingerprint
is_editable	boolean	Indicates if you are allowed to edit entry (wire: isEditable)
nb_archive	integer	Number of archives encrypted with this Encryption Key (wire: nbArchive)
title	string	Encryption Key title
uid	string	Encryption Key user ID

list

Encryption key

Name	Datatype	Description
encryption_key_id	string (uuid)	Encryption Key ID (wire: encryptionKeyId)
algorithm	string	Encryption Key algorithm (ECC25519, RSA4096)
content	string (password)	Encryption Key content
created_at	string (date-time)	Encryption Key creation date (wire: createdAt)
fingerprint	string	Encryption Key fingerprint
is_editable	boolean	Indicates if you are allowed to edit entry (wire: isEditable)
nb_archive	integer	Number of archives encrypted with this Encryption Key (wire: nbArchive)
title	string	Encryption Key title
uid	string	Encryption Key user ID

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	encryption_key_id, service_name		Returns the encryption key.
list	select	service_name	title_pattern, x_pagination_mode	Returns the encryption keys of the Logs Data Platform service.
create	insert	service_name, content, fingerprint, title		Creates an encryption key on the Logs Data Platform service.
delete	delete	encryption_key_id, service_name		Deletes the encryption key.

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"}})
encryption_key_id	string (uuid)	Encryption key ID (wire: encryptionKeyId)
service_name	string	Service name (wire: serviceName)
title_pattern	string	Filter by title (like) (wire: titlePattern)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Returns the encryption key.

SELECT
encryption_key_id,
algorithm,
content,
created_at,
fingerprint,
is_editable,
nb_archive,
title,
uid
FROM ovh.dbaas_logs.encryption_keys
WHERE encryption_key_id = '{{ encryption_key_id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

Returns the encryption keys of the Logs Data Platform service.

SELECT
encryption_key_id,
algorithm,
content,
created_at,
fingerprint,
is_editable,
nb_archive,
title,
uid
FROM ovh.dbaas_logs.encryption_keys
WHERE service_name = '{{ service_name }}' -- required
AND title_pattern = '{{ title_pattern }}'
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Creates an encryption key on the Logs Data Platform service.

INSERT INTO ovh.dbaas_logs.encryption_keys (
content,
fingerprint,
title,
service_name
)
SELECT 
'{{ content }}' /* required */,
'{{ fingerprint }}' /* required */,
'{{ title }}' /* required */,
'{{ service_name }}'
RETURNING
alias_id,
dashboard_id,
encryption_key_id,
index_id,
input_id,
operation_id,
osd_id,
role_id,
stream_id,
subscription_id,
tenant_id,
token_id,
service_name,
created_at,
state,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: encryption_keys
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the encryption_keys resource.
  - name: content
    value: "{{ content }}"
    description: |
      Encryption Key content
  - name: fingerprint
    value: "{{ fingerprint }}"
    description: |
      Encryption Key fingerprint
  - name: title
    value: "{{ title }}"
    description: |
      Encryption Key title

DELETE examples

delete

Deletes the encryption key.

DELETE FROM ovh.dbaas_logs.encryption_keys
WHERE encryption_key_id = '{{ encryption_key_id }}' --required
AND service_name = '{{ service_name }}' --required
;