interconnects

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

Overview

Name	interconnects
Type	Resource
Id	cloudflare.network_interconnects.interconnects

Fields

The following fields are returned by SELECT queries:

get

Information about the specified interconnect

Name	Datatype	Description
name	string
slot_id	string (uuid)
account	string
facility	object
owner	string
region	string
site	string	A Cloudflare site name.
speed	string
type	string

list

List of matching interconnect objects

Name	Datatype	Description
name	string
slot_id	string (uuid)
account	string
facility	object
owner	string
region	string
site	string	A Cloudflare site name.
speed	string
type	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	icon, account_id
list	select	account_id	site, type, cursor, limit
create	insert	account_id, account, type
delete	delete	icon, account_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.
icon	string	Interconnect name to retrieve information about
cursor	integer (int32)
limit	integer
site	string	If specified, only show interconnects located at the given site
type	string	If specified, only show interconnects of the given type

SELECT examples

get

Information about the specified interconnect

SELECT
name,
slot_id,
account,
facility,
owner,
region,
site,
speed,
type
FROM cloudflare.network_interconnects.interconnects
WHERE icon = '{{ icon }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

List of matching interconnect objects

SELECT
name,
slot_id,
account,
facility,
owner,
region,
site,
speed,
type
FROM cloudflare.network_interconnects.interconnects
WHERE account_id = '{{ account_id }}' -- required
AND site = '{{ site }}'
AND type = '{{ type }}'
AND cursor = '{{ cursor }}'
AND limit = '{{ limit }}'
;

INSERT examples

create

No description available.

INSERT INTO cloudflare.network_interconnects.interconnects (
account,
type,
slot_id,
speed,
bandwidth,
pairing_key,
account_id
)
SELECT 
'{{ account }}' /* required */,
'{{ type }}' /* required */,
'{{ slot_id }}',
'{{ speed }}',
'{{ bandwidth }}',
'{{ pairing_key }}',
'{{ account_id }}'
RETURNING
name,
slot_id,
account,
facility,
owner,
region,
site,
speed,
type
;

Manifest

# Description fields are for documentation purposes
- name: interconnects
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the interconnects resource.
  - name: account
    value: "{{ account }}"
  - name: type
    value: "{{ type }}"
  - name: slot_id
    value: "{{ slot_id }}"
  - name: speed
    value: "{{ speed }}"
  - name: bandwidth
    value: "{{ bandwidth }}"
    description: |
      Bandwidth structure as visible through the customer-facing API.
    valid_values: ['50M', '100M', '200M', '300M', '400M', '500M', '1G', '2G', '5G', '10G', '20G', '50G']
  - name: pairing_key
    value: "{{ pairing_key }}"
    description: |
      Pairing key provided by GCP

DELETE examples

delete

No description available.

DELETE FROM cloudflare.network_interconnects.interconnects
WHERE icon = '{{ icon }}' --required
AND account_id = '{{ account_id }}' --required
;