total_tls

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

Overview

Name	total_tls
Type	Resource
Id	cloudflare.acm.total_tls

Fields

The following fields are returned by SELECT queries:

list

Total TLS Settings Details response

Name	Datatype	Description
certificate_authority	string	The Certificate Authority that Total TLS certificates will be issued through. (google, lets_encrypt, ssl_com) (example: google)
enabled	boolean	If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.
validity_period	integer	The validity period in days for the certificates ordered via Total TLS. (90)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Get Total TLS Settings for a Zone.
update	insert	zone_id, enabled		Set Total TLS Settings or disable the feature for a Zone.

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
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Get Total TLS Settings for a Zone.

SELECT
certificate_authority,
enabled,
validity_period
FROM cloudflare.acm.total_tls
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

update

Set Total TLS Settings or disable the feature for a Zone.

INSERT INTO cloudflare.acm.total_tls (
certificate_authority,
enabled,
zone_id
)
SELECT 
'{{ certificate_authority }}',
{{ enabled }} /* required */,
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: total_tls
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the total_tls resource.
  - name: certificate_authority
    value: "{{ certificate_authority }}"
    description: |
      The Certificate Authority that Total TLS certificates will be issued through.
    valid_values: ['google', 'lets_encrypt', 'ssl_com']
  - name: enabled
    value: {{ enabled }}
    description: |
      If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.