bgp_peers

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

Overview

Name	bgp_peers
Type	Resource
Id	aws.directconnect.bgp_peers

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_bgp_peer	insert	region		Creates a BGP peer on the specified virtual interface. You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family. If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface. When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend to use the customer router peer IP address as the source and destination for traffic. Instead you should use RFC 1918 or other addressing, and specify the address yourself. For more information about RFC 1918 see Address Allocation for Private Internets. For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.
delete_bgp_peer	delete	region		Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.

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
region	string	AWS region (default: us-east-1)

INSERT examples

create_bgp_peer

Creates a BGP peer on the specified virtual interface. You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family. If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface. When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses. If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend to use the customer router peer IP address as the source and destination for traffic. Instead you should use RFC 1918 or other addressing, and specify the address yourself. For more information about RFC 1918 see Address Allocation for Private Internets. For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.

INSERT INTO aws.directconnect.bgp_peers (
virtualInterfaceId,
newBGPPeer,
region
)
SELECT 
'{{ virtualInterfaceId }}',
'{{ newBGPPeer }}',
'{{ region }}'
RETURNING
virtual_interface
;

Manifest

# Description fields are for documentation purposes
- name: bgp_peers
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the bgp_peers resource.
  - name: virtualInterfaceId
    value: "{{ virtualInterfaceId }}"
    description: |
      The ID of the virtual interface.
  - name: newBGPPeer
    description: |
      Information about the BGP peer.
    value:
      asn: {{ asn }}
      asnLong: {{ asnLong }}
      authKey: "{{ authKey }}"
      addressFamily: "{{ addressFamily }}"
      amazonAddress: "{{ amazonAddress }}"
      customerAddress: "{{ customerAddress }}"

DELETE examples

delete_bgp_peer

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.

DELETE FROM aws.directconnect.bgp_peers
WHERE region = '{{ region }}' --required
;