2016/12/01 - AWS Direct Connect - 2 new 5 updated api methods
Changes API Update for IPv6 for Direct Connect.
Deletes a BGP peer on the specified virtual interface that matches the specified customer address and ASN. You cannot delete the last BGP peer from a virtual interface.
Request Syntax
client.delete_bgp_peer(
virtualInterfaceId='string',
asn=123,
customerAddress='string'
)
string
The ID of the virtual interface from which the BGP peer will be deleted.
Example: dxvif-456abc78
Default: None
integer
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
string
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'
},
]
}
}
Response Structure
(dict) --
The response received when DeleteBGPPeer is called.
virtualInterface (dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
The AWS account that will own the new virtual interface.
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualInterfaceState (string) --
State of the virtual interface.
Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
Available : A virtual interface that is able to forward traffic.
Down : A virtual interface that is BGP down.
Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
Deleted : A virtual interface that cannot forward traffic.
Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
bgpPeers (list) --
A list of the BGP peers configured on this virtual interface.
(dict) --
A structure containing information about a BGP peer.
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
bgpPeerState (string) --
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.
bgpStatus (string) --
The Up/Down state of the BGP peer.
Up : The BGP peer is established.
Down : The BGP peer is down.
Creates a new BGP peer on a specified virtual interface. The BGP peer cannot be in the same address family (IPv4/IPv6) of an existing BGP peer on the virtual interface.
You must create a BGP peer for the corresponding address family in order to access AWS resources that also use that address family.
When creating a IPv6 BGP peer, the Amazon address and customer address fields must be left blank. IPv6 addresses are automatically assigned from Amazon's pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
For a public virtual interface, the Autonomous System Number (ASN) must be private or already whitelisted for the virtual interface.
Request Syntax
client.create_bgp_peer(
virtualInterfaceId='string',
newBGPPeer={
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string'
}
)
string
The ID of the virtual interface on which the BGP peer will be provisioned.
Example: dxvif-456abc78
Default: None
dict
Detailed information for the BGP peer to be created.
Default: None
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
dict
Response Syntax
{
'virtualInterface': {
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'
},
]
}
}
Response Structure
(dict) --
The response received when CreateBGPPeer is called.
virtualInterface (dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
The AWS account that will own the new virtual interface.
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualInterfaceState (string) --
State of the virtual interface.
Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
Available : A virtual interface that is able to forward traffic.
Down : A virtual interface that is BGP down.
Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
Deleted : A virtual interface that cannot forward traffic.
Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
bgpPeers (list) --
A list of the BGP peers configured on this virtual interface.
(dict) --
A structure containing information about a BGP peer.
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
bgpPeerState (string) --
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.
bgpStatus (string) --
The Up/Down state of the BGP peer.
Up : The BGP peer is established.
Down : The BGP peer is down.
{'newPrivateVirtualInterfaceAllocation': {'addressFamily': 'ipv4 | ipv6'}}
Response {'addressFamily': 'ipv4 | ipv6',
'bgpPeers': [{'addressFamily': 'ipv4 | ipv6',
'amazonAddress': 'string',
'asn': 'integer',
'authKey': 'string',
'bgpPeerState': 'verifying | pending | available | deleting | '
'deleted',
'bgpStatus': 'up | down',
'customerAddress': 'string'}]}
Provisions a private virtual interface to be owned by a different customer.
The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.
Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
Request Syntax
client.allocate_private_virtual_interface(
connectionId='string',
ownerAccount='string',
newPrivateVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'customerAddress': 'string'
}
)
string
[REQUIRED]
The connection ID on which the private virtual interface is provisioned.
Default: None
string
[REQUIRED]
The AWS account that will own the new private virtual interface.
Default: None
dict
[REQUIRED]
Detailed information for the private virtual interface to be provisioned.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
The AWS account that will own the new virtual interface.
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualInterfaceState (string) --
State of the virtual interface.
Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
Available : A virtual interface that is able to forward traffic.
Down : A virtual interface that is BGP down.
Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
Deleted : A virtual interface that cannot forward traffic.
Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
bgpPeers (list) --
A list of the BGP peers configured on this virtual interface.
(dict) --
A structure containing information about a BGP peer.
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
bgpPeerState (string) --
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.
bgpStatus (string) --
The Up/Down state of the BGP peer.
Up : The BGP peer is established.
Down : The BGP peer is down.
{'newPublicVirtualInterfaceAllocation': {'addressFamily': 'ipv4 | ipv6'}}
Response {'addressFamily': 'ipv4 | ipv6',
'bgpPeers': [{'addressFamily': 'ipv4 | ipv6',
'amazonAddress': 'string',
'asn': 'integer',
'authKey': 'string',
'bgpPeerState': 'verifying | pending | available | deleting | '
'deleted',
'bgpStatus': 'up | down',
'customerAddress': 'string'}]}
Provisions a public virtual interface to be owned by a different customer.
The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.
Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.
Request Syntax
client.allocate_public_virtual_interface(
connectionId='string',
ownerAccount='string',
newPublicVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
)
string
[REQUIRED]
The connection ID on which the public virtual interface is provisioned.
Default: None
string
[REQUIRED]
The AWS account that will own the new public virtual interface.
Default: None
dict
[REQUIRED]
Detailed information for the public virtual interface to be provisioned.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
The AWS account that will own the new virtual interface.
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualInterfaceState (string) --
State of the virtual interface.
Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
Available : A virtual interface that is able to forward traffic.
Down : A virtual interface that is BGP down.
Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
Deleted : A virtual interface that cannot forward traffic.
Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
bgpPeers (list) --
A list of the BGP peers configured on this virtual interface.
(dict) --
A structure containing information about a BGP peer.
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
bgpPeerState (string) --
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.
bgpStatus (string) --
The Up/Down state of the BGP peer.
Up : The BGP peer is established.
Down : The BGP peer is down.
{'newPrivateVirtualInterface': {'addressFamily': 'ipv4 | ipv6'}}
Response {'addressFamily': 'ipv4 | ipv6',
'bgpPeers': [{'addressFamily': 'ipv4 | ipv6',
'amazonAddress': 'string',
'asn': 'integer',
'authKey': 'string',
'bgpPeerState': 'verifying | pending | available | deleting | '
'deleted',
'bgpStatus': 'up | down',
'customerAddress': 'string'}]}
Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).
Request Syntax
client.create_private_virtual_interface(
connectionId='string',
newPrivateVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualGatewayId': 'string'
}
)
string
[REQUIRED]
ID of the connection.
Example: dxcon-fg5678gh
Default: None
dict
[REQUIRED]
Detailed information for the private virtual interface to be created.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualGatewayId (string) -- [REQUIRED]
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
The AWS account that will own the new virtual interface.
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualInterfaceState (string) --
State of the virtual interface.
Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
Available : A virtual interface that is able to forward traffic.
Down : A virtual interface that is BGP down.
Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
Deleted : A virtual interface that cannot forward traffic.
Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
bgpPeers (list) --
A list of the BGP peers configured on this virtual interface.
(dict) --
A structure containing information about a BGP peer.
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
bgpPeerState (string) --
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.
bgpStatus (string) --
The Up/Down state of the BGP peer.
Up : The BGP peer is established.
Down : The BGP peer is down.
{'newPublicVirtualInterface': {'addressFamily': 'ipv4 | ipv6'}}
Response {'addressFamily': 'ipv4 | ipv6',
'bgpPeers': [{'addressFamily': 'ipv4 | ipv6',
'amazonAddress': 'string',
'asn': 'integer',
'authKey': 'string',
'bgpPeerState': 'verifying | pending | available | deleting | '
'deleted',
'bgpStatus': 'up | down',
'customerAddress': 'string'}]}
Creates a new public virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A public virtual interface supports sending traffic to public services of AWS such as Amazon Simple Storage Service (Amazon S3).
When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.
Request Syntax
client.create_public_virtual_interface(
connectionId='string',
newPublicVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
]
}
)
string
[REQUIRED]
ID of the connection.
Example: dxcon-fg5678gh
Default: None
dict
[REQUIRED]
Detailed information for the public virtual interface to be created.
Default: None
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) -- [REQUIRED]
The VLAN ID.
Example: 101
asn (integer) -- [REQUIRED]
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'
},
]
}
Response Structure
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
The AWS account that will own the new virtual interface.
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualInterfaceState (string) --
State of the virtual interface.
Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
Available : A virtual interface that is able to forward traffic.
Down : A virtual interface that is BGP down.
Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
Deleted : A virtual interface that cannot forward traffic.
Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
bgpPeers (list) --
A list of the BGP peers configured on this virtual interface.
(dict) --
A structure containing information about a BGP peer.
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
bgpPeerState (string) --
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.
bgpStatus (string) --
The Up/Down state of the BGP peer.
Up : The BGP peer is established.
Down : The BGP peer is down.
{'virtualInterfaces': {'addressFamily': 'ipv4 | ipv6',
'bgpPeers': [{'addressFamily': 'ipv4 | ipv6',
'amazonAddress': 'string',
'asn': 'integer',
'authKey': 'string',
'bgpPeerState': 'verifying | pending | '
'available | deleting | '
'deleted',
'bgpStatus': 'up | down',
'customerAddress': 'string'}]}}
Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.
Request Syntax
client.describe_virtual_interfaces(
connectionId='string',
virtualInterfaceId='string'
)
string
ID of the connection.
Example: dxcon-fg5678gh
Default: None
string
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
dict
Response Syntax
{
'virtualInterfaces': [
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'
},
]
},
]
}
Response Structure
(dict) --
A structure containing a list of virtual interfaces.
virtualInterfaces (list) --
A list of virtual interfaces.
(dict) --
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
ownerAccount (string) --
The AWS account that will own the new virtual interface.
virtualInterfaceId (string) --
ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
ID of the connection.
Example: dxcon-fg5678gh
Default: None
virtualInterfaceType (string) --
The type of virtual interface.
Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer.
Example: "My VPC"
vlan (integer) --
The VLAN ID.
Example: 101
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
virtualInterfaceState (string) --
State of the virtual interface.
Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
Available : A virtual interface that is able to forward traffic.
Down : A virtual interface that is BGP down.
Deleting : A virtual interface is in this state immediately after calling DeleteVirtualInterface until it can no longer forward traffic.
Deleted : A virtual interface that cannot forward traffic.
Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.
customerRouterConfig (string) --
Information for generating the customer router configuration.
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
routeFilterPrefixes (list) --
A list of routes to be advertised to the AWS network in this region (public virtual interface).
(dict) --
A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
CIDR notation for the advertised route. Multiple routes are separated by commas.
IPv6 CIDRs must be at least a /64 or shorter
Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64
bgpPeers (list) --
A list of the BGP peers configured on this virtual interface.
(dict) --
A structure containing information about a BGP peer.
asn (integer) --
Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
Authentication key for BGP configuration.
Example: asdf34example
addressFamily (string) --
Indicates the address family for the BGP peer.
ipv4 : IPv4 address family
ipv6 : IPv6 address family
amazonAddress (string) --
IP address assigned to the Amazon interface.
Example: 192.168.1.1/30 or 2001:db8::1/125
customerAddress (string) --
IP address assigned to the customer interface.
Example: 192.168.1.2/30 or 2001:db8::2/125
bgpPeerState (string) --
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.
bgpStatus (string) --
The Up/Down state of the BGP peer.
Up : The BGP peer is established.
Down : The BGP peer is down.