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

BGPPeer

Information about a BGP peer.

Contents

addressFamily

The address family for the BGP peer.

Type: String

Valid Values: ipv4 | ipv6

Required: No

amazonAddress

The IP address assigned to the Amazon interface.

Type: String

Required: No

asn

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

Type: Integer

Required: No

authKey

The authentication key for BGP configuration.

Type: String

Required: No

awsDeviceV2

The Direct Connect endpoint on which the BGP peer terminates.

Type: String

Required: No

bgpPeerState

The state of the BGP peer. The following are the possible values:

  • verifying: The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.

  • pending: The BGP peer is created, and remains in this state until it is ready to be established.

  • available: The BGP peer is ready to be established.

  • deleting: The BGP peer is being deleted.

  • deleted: The BGP peer is deleted and cannot be established.

Type: String

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

Required: No

bgpStatus

The status of the BGP peer. The following are the possible values:

  • up: The BGP peer is established. This state 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.

  • unknown: The BGP peer status is unknown.

Type: String

Valid Values: up | down

Required: No

customerAddress

The IP address assigned to the customer interface.

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: