AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Information about a BGP peer.

Inheritance Hierarchy

System.Object
  Amazon.DirectConnect.Model.BGPPeer

Namespace: Amazon.DirectConnect.Model
Assembly: AWSSDK.DirectConnect.dll
Version: 3.x.y.z

Syntax

C#
public class BGPPeer

The BGPPeer type exposes the following members

Constructors

NameDescription
Public Method BGPPeer()

Properties

NameTypeDescription
Public Property AddressFamily Amazon.DirectConnect.AddressFamily

Gets and sets the property AddressFamily.

The address family for the BGP peer.

Public Property AmazonAddress System.String

Gets and sets the property AmazonAddress.

The IP address assigned to the Amazon interface.

Public Property Asn System.Int32

Gets and sets the property Asn.

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

Public Property AuthKey System.String

Gets and sets the property AuthKey.

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

Public Property AwsDeviceV2 System.String

Gets and sets the property AwsDeviceV2.

The Direct Connect endpoint that terminates the BGP peer.

Public Property AwsLogicalDeviceId System.String

Gets and sets the property AwsLogicalDeviceId.

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

Public Property BgpPeerId System.String

Gets and sets the property BgpPeerId.

The ID of the BGP peer.

Public Property BgpPeerState Amazon.DirectConnect.BGPPeerState

Gets and sets the property 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.

Public Property BgpStatus Amazon.DirectConnect.BGPStatus

Gets and sets the property 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 not available.

Public Property CustomerAddress System.String

Gets and sets the property CustomerAddress.

The IP address assigned to the customer interface.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5