region_keymanager_certificates

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

Overview

Name	region_keymanager_certificates
Type	Resource
Id	ovh.cloud.region_keymanager_certificates

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string (uuid)	ID of the certificate
name	string	Name of the certificate
region	string	Certificate region
secrets	array	List of secrets in certificate container

list

Key-manager certificate secret container

Name	Datatype	Description
id	string (uuid)	ID of the certificate
name	string	Name of the certificate
region	string	Certificate region
secrets	array	List of secrets in certificate container

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	certificate_id, region_name, service_name		Get details about a certificate
list	select	region_name, service_name		List certificates
create	insert	region_name, service_name, certificate, name, private_key		Create a new certificate
delete	delete	certificate_id, region_name, service_name		Delete a certificate

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"}})
certificate_id	string (uuid)	Certificate ID (wire: certificateId)
region_name	string	Region name (wire: regionName)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get details about a certificate

SELECT
id,
name,
region,
secrets
FROM ovh.cloud.region_keymanager_certificates
WHERE certificate_id = '{{ certificate_id }}' -- required
AND region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List certificates

SELECT
id,
name,
region,
secrets
FROM ovh.cloud.region_keymanager_certificates
WHERE region_name = '{{ region_name }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create a new certificate

INSERT INTO ovh.cloud.region_keymanager_certificates (
certificate,
intermediates,
name,
private_key,
private_key_passphrase,
region_name,
service_name
)
SELECT 
'{{ certificate }}' /* required */,
'{{ intermediates }}',
'{{ name }}' /* required */,
'{{ private_key }}' /* required */,
'{{ private_key_passphrase }}',
'{{ region_name }}',
'{{ service_name }}'
RETURNING
id,
name,
region,
secrets
;

Manifest

# Description fields are for documentation purposes
- name: region_keymanager_certificates
props:
  - name: region_name
    value: "{{ region_name }}"
    description: Required parameter for the region_keymanager_certificates resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the region_keymanager_certificates resource.
  - name: certificate
    value: "{{ certificate }}"
    description: |
      Content of the certificate
  - name: intermediates
    value: "{{ intermediates }}"
    description: |
      Content of the intermediates certificates if any
  - name: name
    value: "{{ name }}"
    description: |
      Name of the certificate
  - name: private_key
    value: "{{ private_key }}"
    description: |
      Private key
  - name: private_key_passphrase
    value: "{{ private_key_passphrase }}"
    description: |
      Private key passphrase if any

DELETE examples

delete

Delete a certificate

DELETE FROM ovh.cloud.region_keymanager_certificates
WHERE certificate_id = '{{ certificate_id }}' --required
AND region_name = '{{ region_name }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;