AWS Direct Connect
API Reference (API Version 2012-10-25)


A structure containing information about a BGP peer.



Indicates the address family for the BGP peer.

  • ipv4: IPv4 address family

  • ipv6: IPv6 address family

Type: String

Valid Values: ipv4 | ipv6

Required: No


IP address assigned to the Amazon interface.

Example: or 2001:db8::1/125

Type: String

Required: No


The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

Example: 65000

Type: Integer

Required: No


The authentication key for BGP configuration.

Example: asdf34example

Type: String

Required: No


The state of the BGP peer.

  • Verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.

  • Pending: The BGP peer has been created, and is in this state until it is ready to be established.

  • Available: The BGP peer can be established.

  • Deleting: The BGP peer is in the process of being deleted.

  • Deleted: The BGP peer has been deleted and cannot be established.

Type: String

Valid Values: verifying | pending | available | deleting | deleted

Required: No


The Up/Down state of the BGP peer.

  • Up: The BGP peer is established.


    A state of up does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.

  • Down: The BGP peer is down.

Type: String

Valid Values: up | down

Required: No


IP address assigned to the customer interface.

Example: or 2001:db8::2/125

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: