attached_domain_ssls

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

Overview

Name	attached_domain_ssls
Type	Resource
Id	ovh.hosting_web.attached_domain_ssls

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
task_id	integer	The task ID working on this Hosted SSL (wire: taskId)
is_reportable	boolean	If the hostedssl is currently bound to a report (wire: isReportable)
provider	string	Provider of the Hosted SSL (COMODO, CUSTOM, LETSENCRYPT, SECTIGO)
regenerable	boolean	Regenerable flag
status	string	Status of the Hosted SSL (created, creating, deleting, importing, regenerating)
type	string	Type of the Hosted SSL (CUSTOM, DV, EV)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	domain, service_name		Returns the provider, type and status of the SSL certificate of the attached domain.
create	insert	domain, service_name		Creates the free Let's Encrypt SSL certificate of the attached domain.
update	update	domain, service_name		Updates the SSL certificate of the attached domain. Set regenerate to true to regenerate it.
delete	delete	domain, service_name		Deletes the SSL certificate of the attached domain.
regenerate	exec	domain, serviceName		Regenerates the SSL certificate of the attached domain.

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"}})
domain	string	Domain
serviceName	string	Service name
service_name	string	Service name (wire: serviceName)

SELECT examples

get

Returns the provider, type and status of the SSL certificate of the attached domain.

SELECT
task_id,
is_reportable,
provider,
regenerable,
status,
type
FROM ovh.hosting_web.attached_domain_ssls
WHERE domain = '{{ domain }}' -- required
AND service_name = '{{ service_name }}' -- required
;

INSERT examples

create

Creates the free Let's Encrypt SSL certificate of the attached domain.

INSERT INTO ovh.hosting_web.attached_domain_ssls (
domain,
service_name
)
SELECT 
'{{ domain }}',
'{{ service_name }}'
RETURNING
task_id,
is_reportable,
provider,
regenerable,
status,
type
;

Manifest

# Description fields are for documentation purposes
- name: attached_domain_ssls
props:
  - name: domain
    value: "{{ domain }}"
    description: Required parameter for the attached_domain_ssls resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the attached_domain_ssls resource.

UPDATE examples

update

Updates the SSL certificate of the attached domain. Set regenerate to true to regenerate it.

UPDATE ovh.hosting_web.attached_domain_ssls
SET 
regenerate = {{ regenerate }}
WHERE 
domain = '{{ domain }}' --required
AND service_name = '{{ service_name }}' --required
RETURNING
task_id,
is_reportable,
provider,
regenerable,
status,
type;

DELETE examples

delete

Deletes the SSL certificate of the attached domain.

DELETE FROM ovh.hosting_web.attached_domain_ssls
WHERE domain = '{{ domain }}' --required
AND service_name = '{{ service_name }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

regenerate

Regenerates the SSL certificate of the attached domain.

EXEC ovh.hosting_web.attached_domain_ssls.regenerate 
@domain='{{ domain }}' --required, 
@serviceName='{{ serviceName }}' --required
;