on_ramps

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

Overview

Name	on_ramps
Type	Resource
Id	cloudflare.magic_cloud_networking.on_ramps

Fields

The following fields are returned by SELECT queries:

get

OK.

Name	Datatype	Description
id	string (uuid)
name	string
vpcs_by_id	object
attached_hubs	array
attached_vpcs	array
cloud_asn	integer (uint32)
cloud_type	string	(AWS, AZURE, GOOGLE)
description	string
dynamic_routing	boolean
hub	string (uuid)
install_routes_in_cloud	boolean
install_routes_in_magic_wan	boolean
last_applied_at	string
last_exported_at	string
last_planned_at	string
manage_hub_to_hub_attachments	boolean
manage_vpc_to_hub_attachments	boolean
planned_monthly_cost_estimate	object
planned_resources	array
planned_resources_unavailable	boolean
post_apply_monthly_cost_estimate	object
post_apply_resources	object
post_apply_resources_unavailable	boolean
region	string
status	object
type	string	(OnrampTypeSingle, OnrampTypeHub)
updated_at	string
vpc	string (uuid)
vpcs_by_id_unavailable	array	The list of vpc IDs for which resource details failed to generate.

list

OK.

Name	Datatype	Description
id	string (uuid)
name	string
vpcs_by_id	object
attached_hubs	array
attached_vpcs	array
cloud_asn	integer (uint32)
cloud_type	string	(AWS, AZURE, GOOGLE)
description	string
dynamic_routing	boolean
hub	string (uuid)
install_routes_in_cloud	boolean
install_routes_in_magic_wan	boolean
last_applied_at	string
last_exported_at	string
last_planned_at	string
manage_hub_to_hub_attachments	boolean
manage_vpc_to_hub_attachments	boolean
planned_monthly_cost_estimate	object
planned_resources	array
planned_resources_unavailable	boolean
post_apply_monthly_cost_estimate	object
post_apply_resources	object
post_apply_resources_unavailable	boolean
region	string
status	object
type	string	(OnrampTypeSingle, OnrampTypeHub)
updated_at	string
vpc	string (uuid)
vpcs_by_id_unavailable	array	The list of vpc IDs for which resource details failed to generate.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, onramp_id	status, vpcs, post_apply_resources, planned_resources	Read an On-ramp (Closed Beta).
list	select	account_id	order_by, desc, status, vpcs	List On-ramps (Closed Beta).
create	insert	account_id, name, type, cloud_type, install_routes_in_cloud, install_routes_in_magic_wan, dynamic_routing	forwarded	Create a new On-ramp (Closed Beta).
edit	update	account_id, onramp_id		Update an On-ramp (Closed Beta).
update	replace	account_id, onramp_id		Update an On-ramp (Closed Beta).
delete	delete	account_id, onramp_id	destroy, force	Delete an On-ramp (Closed Beta).

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.
onramp_id	string (uuid)
desc	boolean
destroy	boolean
force	boolean
forwarded	string
order_by	string	One of ["updated_at", "id", "cloud_type", "name"].
planned_resources	boolean
post_apply_resources	boolean
status	boolean
vpcs	boolean

SELECT examples

get

Read an On-ramp (Closed Beta).

SELECT
id,
name,
vpcs_by_id,
attached_hubs,
attached_vpcs,
cloud_asn,
cloud_type,
description,
dynamic_routing,
hub,
install_routes_in_cloud,
install_routes_in_magic_wan,
last_applied_at,
last_exported_at,
last_planned_at,
manage_hub_to_hub_attachments,
manage_vpc_to_hub_attachments,
planned_monthly_cost_estimate,
planned_resources,
planned_resources_unavailable,
post_apply_monthly_cost_estimate,
post_apply_resources,
post_apply_resources_unavailable,
region,
status,
type,
updated_at,
vpc,
vpcs_by_id_unavailable
FROM cloudflare.magic_cloud_networking.on_ramps
WHERE account_id = '{{ account_id }}' -- required
AND onramp_id = '{{ onramp_id }}' -- required
AND status = '{{ status }}'
AND vpcs = '{{ vpcs }}'
AND post_apply_resources = '{{ post_apply_resources }}'
AND planned_resources = '{{ planned_resources }}'
;

list

List On-ramps (Closed Beta).

SELECT
id,
name,
vpcs_by_id,
attached_hubs,
attached_vpcs,
cloud_asn,
cloud_type,
description,
dynamic_routing,
hub,
install_routes_in_cloud,
install_routes_in_magic_wan,
last_applied_at,
last_exported_at,
last_planned_at,
manage_hub_to_hub_attachments,
manage_vpc_to_hub_attachments,
planned_monthly_cost_estimate,
planned_resources,
planned_resources_unavailable,
post_apply_monthly_cost_estimate,
post_apply_resources,
post_apply_resources_unavailable,
region,
status,
type,
updated_at,
vpc,
vpcs_by_id_unavailable
FROM cloudflare.magic_cloud_networking.on_ramps
WHERE account_id = '{{ account_id }}' -- required
AND order_by = '{{ order_by }}'
AND desc = '{{ desc }}'
AND status = '{{ status }}'
AND vpcs = '{{ vpcs }}'
;

INSERT examples

create

Create a new On-ramp (Closed Beta).

INSERT INTO cloudflare.magic_cloud_networking.on_ramps (
adopted_hub_id,
attached_hubs,
attached_vpcs,
cloud_asn,
cloud_type,
description,
dynamic_routing,
hub_provider_id,
install_routes_in_cloud,
install_routes_in_magic_wan,
manage_hub_to_hub_attachments,
manage_vpc_to_hub_attachments,
name,
region,
type,
vpc,
account_id,
forwarded
)
SELECT 
'{{ adopted_hub_id }}',
'{{ attached_hubs }}',
'{{ attached_vpcs }}',
{{ cloud_asn }},
'{{ cloud_type }}' /* required */,
'{{ description }}',
{{ dynamic_routing }} /* required */,
'{{ hub_provider_id }}',
{{ install_routes_in_cloud }} /* required */,
{{ install_routes_in_magic_wan }} /* required */,
{{ manage_hub_to_hub_attachments }},
{{ manage_vpc_to_hub_attachments }},
'{{ name }}' /* required */,
'{{ region }}',
'{{ type }}' /* required */,
'{{ vpc }}',
'{{ account_id }}',
'{{ forwarded }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: on_ramps
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the on_ramps resource.
  - name: adopted_hub_id
    value: "{{ adopted_hub_id }}"
  - name: attached_hubs
    value:
      - "{{ attached_hubs }}"
  - name: attached_vpcs
    value:
      - "{{ attached_vpcs }}"
  - name: cloud_asn
    value: {{ cloud_asn }}
    description: |
      Sets the cloud-side ASN. If unset or zero, the cloud's default ASN takes effect.
  - name: cloud_type
    value: "{{ cloud_type }}"
    valid_values: ['AWS', 'AZURE', 'GOOGLE']
  - name: description
    value: "{{ description }}"
  - name: dynamic_routing
    value: {{ dynamic_routing }}
    description: |
      Enables BGP routing. When enabling this feature, set both install_routes_in_cloud and install_routes_in_magic_wan to false.
  - name: hub_provider_id
    value: "{{ hub_provider_id }}"
  - name: install_routes_in_cloud
    value: {{ install_routes_in_cloud }}
  - name: install_routes_in_magic_wan
    value: {{ install_routes_in_magic_wan }}
  - name: manage_hub_to_hub_attachments
    value: {{ manage_hub_to_hub_attachments }}
  - name: manage_vpc_to_hub_attachments
    value: {{ manage_vpc_to_hub_attachments }}
  - name: name
    value: "{{ name }}"
  - name: region
    value: "{{ region }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['OnrampTypeSingle', 'OnrampTypeHub']
  - name: vpc
    value: "{{ vpc }}"
  - name: forwarded
    value: "{{ forwarded }}"

UPDATE examples

edit

Update an On-ramp (Closed Beta).

UPDATE cloudflare.magic_cloud_networking.on_ramps
SET 
attached_hubs = '{{ attached_hubs }}',
attached_vpcs = '{{ attached_vpcs }}',
description = '{{ description }}',
install_routes_in_cloud = {{ install_routes_in_cloud }},
install_routes_in_magic_wan = {{ install_routes_in_magic_wan }},
manage_hub_to_hub_attachments = {{ manage_hub_to_hub_attachments }},
manage_vpc_to_hub_attachments = {{ manage_vpc_to_hub_attachments }},
name = '{{ name }}',
vpc = '{{ vpc }}'
WHERE 
account_id = '{{ account_id }}' --required
AND onramp_id = '{{ onramp_id }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update

Update an On-ramp (Closed Beta).

REPLACE cloudflare.magic_cloud_networking.on_ramps
SET 
attached_hubs = '{{ attached_hubs }}',
attached_vpcs = '{{ attached_vpcs }}',
description = '{{ description }}',
install_routes_in_cloud = {{ install_routes_in_cloud }},
install_routes_in_magic_wan = {{ install_routes_in_magic_wan }},
manage_hub_to_hub_attachments = {{ manage_hub_to_hub_attachments }},
manage_vpc_to_hub_attachments = {{ manage_vpc_to_hub_attachments }},
name = '{{ name }}',
vpc = '{{ vpc }}'
WHERE 
account_id = '{{ account_id }}' --required
AND onramp_id = '{{ onramp_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete an On-ramp (Closed Beta).

DELETE FROM cloudflare.magic_cloud_networking.on_ramps
WHERE account_id = '{{ account_id }}' --required
AND onramp_id = '{{ onramp_id }}' --required
AND destroy = '{{ destroy }}'
AND force = '{{ force }}'
;