connectors

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

Overview

Name	connectors
Type	Resource
Id	cloudflare.magic_transit.connectors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string
activated	boolean	(x-stainless-terraform-configurability: computed_optional)
device	object
interrupt_window_days_of_week	array	Allowed days of the week for upgrades. Default is all days. (x-stainless-terraform-configurability: computed_optional)
interrupt_window_duration_hours	number	(x-stainless-terraform-configurability: computed_optional)
interrupt_window_embargo_dates	array	List of dates (YYYY-MM-DD) when upgrades are blocked. (x-stainless-terraform-configurability: computed_optional)
interrupt_window_hour_of_day	number	(x-stainless-terraform-configurability: computed_optional)
last_heartbeat	string
last_seen_version	string
last_updated	string
license_key	string	(x-stainless-terraform-configurability: computed_optional)
notes	string	(x-stainless-terraform-configurability: computed_optional)
timezone	string	(x-stainless-terraform-configurability: computed_optional)

list

Name	Datatype	Description
id	string
activated	boolean	(x-stainless-terraform-configurability: computed_optional)
device	object
interrupt_window_days_of_week	array	Allowed days of the week for upgrades. Default is all days. (x-stainless-terraform-configurability: computed_optional)
interrupt_window_duration_hours	number	(x-stainless-terraform-configurability: computed_optional)
interrupt_window_embargo_dates	array	List of dates (YYYY-MM-DD) when upgrades are blocked. (x-stainless-terraform-configurability: computed_optional)
interrupt_window_hour_of_day	number	(x-stainless-terraform-configurability: computed_optional)
last_heartbeat	string
last_seen_version	string
last_updated	string
license_key	string	(x-stainless-terraform-configurability: computed_optional)
notes	string	(x-stainless-terraform-configurability: computed_optional)
timezone	string	(x-stainless-terraform-configurability: computed_optional)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, connector_id
list	select	account_id	device_type
create	insert	account_id, device
edit	update	account_id, connector_id
update	replace	account_id, connector_id
delete	delete	account_id, connector_id

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
account_id	string	The Cloudflare account ID.
connector_id	string
device_type	string	Filter connectors by device type.

SELECT examples

get

OK

SELECT
id,
activated,
device,
interrupt_window_days_of_week,
interrupt_window_duration_hours,
interrupt_window_embargo_dates,
interrupt_window_hour_of_day,
last_heartbeat,
last_seen_version,
last_updated,
license_key,
notes,
timezone
FROM cloudflare.magic_transit.connectors
WHERE account_id = '{{ account_id }}' -- required
AND connector_id = '{{ connector_id }}' -- required
;

list

OK

SELECT
id,
activated,
device,
interrupt_window_days_of_week,
interrupt_window_duration_hours,
interrupt_window_embargo_dates,
interrupt_window_hour_of_day,
last_heartbeat,
last_seen_version,
last_updated,
license_key,
notes,
timezone
FROM cloudflare.magic_transit.connectors
WHERE account_id = '{{ account_id }}' -- required
AND device_type = '{{ device_type }}'
;

INSERT examples

create

No description available.

INSERT INTO cloudflare.magic_transit.connectors (
device,
activated,
interrupt_window_days_of_week,
interrupt_window_duration_hours,
interrupt_window_embargo_dates,
interrupt_window_hour_of_day,
notes,
timezone,
account_id
)
SELECT 
'{{ device }}' /* required */,
{{ activated }},
'{{ interrupt_window_days_of_week }}',
{{ interrupt_window_duration_hours }},
'{{ interrupt_window_embargo_dates }}',
{{ interrupt_window_hour_of_day }},
'{{ notes }}',
'{{ timezone }}',
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the connectors resource.
  - name: device
    description: |
      Exactly one of id, serial_number, or provision_license must be provided.
    value:
      id: "{{ id }}"
      provision_license: {{ provision_license }}
      serial_number: "{{ serial_number }}"
  - name: activated
    value: {{ activated }}
  - name: interrupt_window_days_of_week
    value:
      - "{{ interrupt_window_days_of_week }}"
    description: |
      Allowed days of the week for upgrades. Default is all days.
  - name: interrupt_window_duration_hours
    value: {{ interrupt_window_duration_hours }}
  - name: interrupt_window_embargo_dates
    value:
      - "{{ interrupt_window_embargo_dates }}"
    description: |
      List of dates (YYYY-MM-DD) when upgrades are blocked.
  - name: interrupt_window_hour_of_day
    value: {{ interrupt_window_hour_of_day }}
  - name: notes
    value: "{{ notes }}"
  - name: timezone
    value: "{{ timezone }}"

UPDATE examples

edit

No description available.

UPDATE cloudflare.magic_transit.connectors
SET 
activated = {{ activated }},
interrupt_window_days_of_week = '{{ interrupt_window_days_of_week }}',
interrupt_window_duration_hours = {{ interrupt_window_duration_hours }},
interrupt_window_embargo_dates = '{{ interrupt_window_embargo_dates }}',
interrupt_window_hour_of_day = {{ interrupt_window_hour_of_day }},
notes = '{{ notes }}',
timezone = '{{ timezone }}',
provision_license = {{ provision_license }}
WHERE 
account_id = '{{ account_id }}' --required
AND connector_id = '{{ connector_id }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update

No description available.

REPLACE cloudflare.magic_transit.connectors
SET 
activated = {{ activated }},
interrupt_window_days_of_week = '{{ interrupt_window_days_of_week }}',
interrupt_window_duration_hours = {{ interrupt_window_duration_hours }},
interrupt_window_embargo_dates = '{{ interrupt_window_embargo_dates }}',
interrupt_window_hour_of_day = {{ interrupt_window_hour_of_day }},
notes = '{{ notes }}',
timezone = '{{ timezone }}',
provision_license = {{ provision_license }}
WHERE 
account_id = '{{ account_id }}' --required
AND connector_id = '{{ connector_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

No description available.

DELETE FROM cloudflare.magic_transit.connectors
WHERE account_id = '{{ account_id }}' --required
AND connector_id = '{{ connector_id }}' --required
;