partner_attachments

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

Overview

Name	partner_attachments
Type	Resource
Id	digitalocean.network.partner_attachments

Fields

The following fields are returned by SELECT queries:

partner_attachments_get

The response will be a JSON object with details about the partner attachment
including attached VPC network IDs and BGP configuration information

Name	Datatype	Description
id	string (string)	A unique ID that can be used to identify and reference the partner attachment. (example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4)
name	string	The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9-.]+$, example: env.prod-partner-network-connect)
bgp	object	The BGP configuration for the partner attachment.
children	array	An array of associated partner attachment UUIDs.
connection_bandwidth_in_mbps	integer	The bandwidth (in Mbps) of the connection.
created_at	string (date-time)	A time value given in ISO8601 combined date and time format. (example: 2020-03-13T19:20:47.442049222Z)
naas_provider	string	The Network as a Service (NaaS) provider for the partner attachment. (example: megaport)
parent_uuid	string	Associated partner attachment UUID (example: 34259a41-0ca6-4a6b-97dd-a22bcab900dd)
region	string	The region where the partner attachment is located. (example: nyc)
state	string	The current operational state of the attachment. (example: active)
vpc_ids	array	An array of VPC network IDs.

partner_attachments_list

The response will be a JSON object with a partner_attachments key
that contains an array of all partner attachments

Name	Datatype	Description
id	string (string)	A unique ID that can be used to identify and reference the partner attachment. (example: 5a4981aa-9653-4bd1-bef5-d6bff52042e4)
name	string	The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods. (pattern: ^[a-zA-Z0-9-.]+$, example: env.prod-partner-network-connect)
bgp	object	The BGP configuration for the partner attachment.
children	array	An array of associated partner attachment UUIDs.
connection_bandwidth_in_mbps	integer	The bandwidth (in Mbps) of the connection.
created_at	string (date-time)	A time value given in ISO8601 combined date and time format. (example: 2020-03-13T19:20:47.442049222Z)
naas_provider	string	The Network as a Service (NaaS) provider for the partner attachment. (example: megaport)
parent_uuid	string	Associated partner attachment UUID (example: 34259a41-0ca6-4a6b-97dd-a22bcab900dd)
region	string	The region where the partner attachment is located. (example: nyc)
state	string	The current operational state of the attachment. (example: active)
vpc_ids	array	An array of VPC network IDs.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
partner_attachments_get	select	pa_id		To get the details of a partner attachment, send a GET request to /v2/partner_network_connect/attachments/{pa_id}.
partner_attachments_list	select		per_page, page	To list all of the Partner Attachments on your account, send a GET request to /v2/partner_network_connect/attachments.
partner_attachments_create	insert	name, connection_bandwidth_in_mbps, region, naas_provider, vpc_ids		To create a new partner attachment, send a POST request to /v2/partner_network_connect/attachments with a JSON object containing the required configuration details.
partner_attachments_patch	update	pa_id, name, vpc_ids		To update an existing partner attachment, send a PATCH request to /v2/partner_network_connect/attachments/{pa_id} with a JSON object containing the fields to be updated.
partner_attachments_delete	delete	pa_id		To delete an existing partner attachment, send a DELETE request to /v2/partner_network_connect/attachments/{pa_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
pa_id	string (string)	A unique identifier for a partner attachment. (example: 4de7ac8b-495b-4884-9a69-1050c6793cd6)
page	integer	Which 'page' of paginated results to return. (example: 1)
per_page	integer	Number of items returned per page (example: 2)

SELECT examples

partner_attachments_get

To get the details of a partner attachment, send a GET request to
/v2/partner_network_connect/attachments/{pa_id}.

SELECT
id,
name,
bgp,
children,
connection_bandwidth_in_mbps,
created_at,
naas_provider,
parent_uuid,
region,
state,
vpc_ids
FROM digitalocean.network.partner_attachments
WHERE pa_id = '{{ pa_id }}' -- required
;

partner_attachments_list

To list all of the Partner Attachments on your account, send a GET request to /v2/partner_network_connect/attachments.

SELECT
id,
name,
bgp,
children,
connection_bandwidth_in_mbps,
created_at,
naas_provider,
parent_uuid,
region,
state,
vpc_ids
FROM digitalocean.network.partner_attachments
WHERE per_page = '{{ per_page }}'
AND page = '{{ page }}'
;

INSERT examples

partner_attachments_create

To create a new partner attachment, send a POST request to
/v2/partner_network_connect/attachments with a JSON object containing the
required configuration details.

INSERT INTO digitalocean.network.partner_attachments (
name,
connection_bandwidth_in_mbps,
region,
naas_provider,
vpc_ids,
parent_uuid,
bgp,
redundancy_zone
)
SELECT 
'{{ name }}' /* required */,
{{ connection_bandwidth_in_mbps }} /* required */,
'{{ region }}' /* required */,
'{{ naas_provider }}' /* required */,
'{{ vpc_ids }}' /* required */,
'{{ parent_uuid }}',
'{{ bgp }}',
'{{ redundancy_zone }}'
RETURNING
partner_attachment
;

Manifest

# Description fields are for documentation purposes
- name: partner_attachments
props:
  - name: name
    value: "{{ name }}"
    description: |
      The name of the partner attachment. Must be unique and may only contain alphanumeric characters, dashes, and periods.
  - name: connection_bandwidth_in_mbps
    value: {{ connection_bandwidth_in_mbps }}
    description: |
      Bandwidth (in Mbps) of the connection.
    valid_values: ['1000', '2000', '5000', '10000']
  - name: region
    value: "{{ region }}"
    description: |
      The region to create the partner attachment.
    valid_values: ['nyc', 'sfo', 'fra', 'ams', 'sgp']
  - name: naas_provider
    value: "{{ naas_provider }}"
  - name: vpc_ids
    value:
      - "{{ vpc_ids }}"
    description: |
      An array of VPCs IDs.
  - name: parent_uuid
    value: "{{ parent_uuid }}"
    description: |
      Optional associated partner attachment UUID
  - name: bgp
    description: |
      Optional BGP configurations
    value:
      local_router_ip: "{{ local_router_ip }}"
      peer_router_ip: "{{ peer_router_ip }}"
      peer_router_asn: {{ peer_router_asn }}
      auth_key: "{{ auth_key }}"
  - name: redundancy_zone
    value: "{{ redundancy_zone }}"
    description: |
      Optional redundancy zone for the partner attachment.
    valid_values: ['MEGAPORT_BLUE', 'MEGAPORT_RED']

UPDATE examples

partner_attachments_patch

To update an existing partner attachment, send a PATCH request to
/v2/partner_network_connect/attachments/{pa_id} with a JSON object containing the
fields to be updated.

UPDATE digitalocean.network.partner_attachments
SET 
name = '{{ name }}',
vpc_ids = '{{ vpc_ids }}',
bgp = '{{ bgp }}'
WHERE 
pa_id = '{{ pa_id }}' --required
AND name = '{{ name }}' --required
AND vpc_ids = '{{ vpc_ids }}' --required
RETURNING
partner_attachment;

DELETE examples

partner_attachments_delete

To delete an existing partner attachment, send a DELETE request to
/v2/partner_network_connect/attachments/{pa_id}.

DELETE FROM digitalocean.network.partner_attachments
WHERE pa_id = '{{ pa_id }}' --required
;