Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface BGPPeer

Information about a BGP peer.

Hierarchy

  • BGPPeer

Properties

addressFamily? amazonAddress? asn? authKey? awsDeviceV2? awsLogicalDeviceId? bgpPeerId? bgpPeerState? bgpStatus? customerAddress?

Properties

Optional addressFamily

addressFamily?: string

The address family for the BGP peer.

Optional amazonAddress

amazonAddress?: string

The IP address assigned to the Amazon interface.

Optional asn

asn?: number

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

Optional authKey

authKey?: string

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Optional awsDeviceV2

awsDeviceV2?: string

The Direct Connect endpoint that terminates the BGP peer.

Optional awsLogicalDeviceId

awsLogicalDeviceId?: string

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

Optional bgpPeerId

bgpPeerId?: string

The ID of the BGP peer.

Optional bgpPeerState

bgpPeerState?: string

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.

Optional bgpStatus

bgpStatus?: string

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 not available.

Optional customerAddress

customerAddress?: string

The IP address assigned to the customer interface.

Settings

Member Visibility

Theme