2017/11/01 - AWS Direct Connect - 7 new 9 updated api methods
Changes AWS DirectConnect now provides support for Global Access for Virtual Private Cloud (VPC) via a new feature called Direct Connect Gateway. A Direct Connect Gateway will allow you to group multiple Direct Connect Private Virtual Interfaces (DX-VIF) and Private Virtual Gateways (VGW) from different AWS regions (but belonging to the same AWS Account) and pass traffic from any DX-VIF to any VPC in the grouping.
Creates an association between a direct connect gateway and a virtual private gateway (VGW). The VGW must be attached to a VPC and must not be associated with another direct connect gateway.
See also: AWS API Documentation
Request Syntax
client.create_direct_connect_gateway_association(
directConnectGatewayId='string',
virtualGatewayId='string'
)
string
[REQUIRED]
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
Default: None
string
[REQUIRED]
The ID of the virtual private gateway.
Example: "vgw-abc123ef"
Default: None
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated',
'stateChangeError': 'string'
}
}
Response Structure
(dict) --
Container for the response from the CreateDirectConnectGatewayAssociation API call
directConnectGatewayAssociation (dict) --
The direct connect gateway association to be created.
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
virtualGatewayRegion (string) --
The region in which the virtual private gateway is located.
Example: us-east-1
virtualGatewayOwnerAccount (string) --
The AWS account ID of the owner of the virtual private gateway.
associationState (string) --
State of the direct connect gateway association.
Associating : The initial state after calling CreateDirectConnectGatewayAssociation .
Associated : The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.
Disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation .
Disassociated : The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.
stateChangeError (string) --
Error message when the state of an object fails to advance.
Deletes a direct connect gateway. You must first delete all virtual interfaces that are attached to the direct connect gateway and disassociate all virtual private gateways that are associated with the direct connect gateway.
See also: AWS API Documentation
Request Syntax
client.delete_direct_connect_gateway(
directConnectGatewayId='string'
)
string
[REQUIRED]
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
Default: None
dict
Response Syntax
{
'directConnectGateway': {
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
}
}
Response Structure
(dict) --
Container for the response from the DeleteDirectConnectGateway API call
directConnectGateway (dict) --
The direct connect gateway to be deleted.
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
directConnectGatewayName (string) --
The name of the direct connect gateway.
Example: "My direct connect gateway"
Default: None
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
ownerAccount (string) --
The AWS account ID of the owner of the direct connect gateway.
directConnectGatewayState (string) --
State of the direct connect gateway.
Pending : The initial state after calling CreateDirectConnectGateway .
Available : The direct connect gateway is ready for use.
Deleting : The initial state after calling DeleteDirectConnectGateway .
Deleted : The direct connect gateway is deleted and cannot pass traffic.
stateChangeError (string) --
Error message when the state of an object fails to advance.
Creates a new direct connect gateway. A direct connect gateway is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. direct connect gateways are global and visible in any AWS region after they are created. The virtual interfaces and virtual private gateways that are connected through a direct connect gateway can be in different regions. This enables you to connect to a VPC in any region, regardless of the region in which the virtual interfaces are located, and pass traffic between them.
See also: AWS API Documentation
Request Syntax
client.create_direct_connect_gateway(
directConnectGatewayName='string',
amazonSideAsn=123
)
string
[REQUIRED]
The name of the direct connect gateway.
Example: "My direct connect gateway"
Default: None
integer
The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294
Example: 65200
Default: 64512
dict
Response Syntax
{
'directConnectGateway': {
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
}
}
Response Structure
(dict) --
Container for the response from the CreateDirectConnectGateway API call
directConnectGateway (dict) --
The direct connect gateway to be created.
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
directConnectGatewayName (string) --
The name of the direct connect gateway.
Example: "My direct connect gateway"
Default: None
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
ownerAccount (string) --
The AWS account ID of the owner of the direct connect gateway.
directConnectGatewayState (string) --
State of the direct connect gateway.
Pending : The initial state after calling CreateDirectConnectGateway .
Available : The direct connect gateway is ready for use.
Deleting : The initial state after calling DeleteDirectConnectGateway .
Deleted : The direct connect gateway is deleted and cannot pass traffic.
stateChangeError (string) --
Error message when the state of an object fails to advance.
Deletes the association between a direct connect gateway and a virtual private gateway.
See also: AWS API Documentation
Request Syntax
client.delete_direct_connect_gateway_association(
directConnectGatewayId='string',
virtualGatewayId='string'
)
string
[REQUIRED]
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
Default: None
string
[REQUIRED]
The ID of the virtual private gateway.
Example: "vgw-abc123ef"
Default: None
dict
Response Syntax
{
'directConnectGatewayAssociation': {
'directConnectGatewayId': 'string',
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated',
'stateChangeError': 'string'
}
}
Response Structure
(dict) --
Container for the response from the DeleteDirectConnectGatewayAssociation API call
directConnectGatewayAssociation (dict) --
The direct connect gateway association to be deleted.
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
virtualGatewayRegion (string) --
The region in which the virtual private gateway is located.
Example: us-east-1
virtualGatewayOwnerAccount (string) --
The AWS account ID of the owner of the virtual private gateway.
associationState (string) --
State of the direct connect gateway association.
Associating : The initial state after calling CreateDirectConnectGatewayAssociation .
Associated : The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.
Disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation .
Disassociated : The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.
stateChangeError (string) --
Error message when the state of an object fails to advance.
Returns a list of all direct connect gateway and virtual interface (VIF) attachments. Either a direct connect gateway ID or a VIF ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VIFs attached to the direct connect gateway. If a VIF ID is provided, the response returns all direct connect gateways attached to the VIF. If both are provided, the response only returns the attachment that matches both the direct connect gateway and the VIF.
See also: AWS API Documentation
Request Syntax
client.describe_direct_connect_gateway_attachments(
directConnectGatewayId='string',
virtualInterfaceId='string',
maxResults=123,
nextToken='string'
)
string
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
Default: None
string
The ID of the virtual interface.
Example: "dxvif-abc123ef"
Default: None
integer
The maximum number of direct connect gateway attachments to return per page.
Example: 15
Default: None
string
The token provided in the previous describe result to retrieve the next page of the result.
Default: None
dict
Response Syntax
{
'directConnectGatewayAttachments': [
{
'directConnectGatewayId': 'string',
'virtualInterfaceId': 'string',
'virtualInterfaceRegion': 'string',
'virtualInterfaceOwnerAccount': 'string',
'attachmentState': 'attaching'|'attached'|'detaching'|'detached',
'stateChangeError': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Container for the response from the DescribeDirectConnectGatewayAttachments API call
directConnectGatewayAttachments (list) --
Information about the direct connect gateway attachments.
(dict) --
The association between a direct connect gateway and virtual interface.
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
virtualInterfaceId (string) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
virtualInterfaceRegion (string) --
The region in which the virtual interface is located.
Example: us-east-1
virtualInterfaceOwnerAccount (string) --
The AWS account ID of the owner of the virtual interface.
attachmentState (string) --
State of the direct connect gateway attachment.
Attaching : The initial state after a virtual interface is created using the direct connect gateway.
Attached : The direct connect gateway and virtual interface are successfully attached and ready to pass traffic.
Detaching : The initial state after calling DeleteVirtualInterface on a virtual interface that is attached to a direct connect gateway.
Detached : The virtual interface is successfully detached from the direct connect gateway. Traffic flow between the direct connect gateway and virtual interface stops.
stateChangeError (string) --
Error message when the state of an object fails to advance.
nextToken (string) --
Token to retrieve the next page of the result.
Returns a list of direct connect gateways in your account. Deleted direct connect gateways are not returned. You can provide a direct connect gateway ID in the request to return information about the specific direct connect gateway only. Otherwise, if a direct connect gateway ID is not provided, information about all of your direct connect gateways is returned.
See also: AWS API Documentation
Request Syntax
client.describe_direct_connect_gateways(
directConnectGatewayId='string',
maxResults=123,
nextToken='string'
)
string
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
Default: None
integer
The maximum number of direct connect gateways to return per page.
Example: 15
Default: None
string
The token provided in the previous describe result to retrieve the next page of the result.
Default: None
dict
Response Syntax
{
'directConnectGateways': [
{
'directConnectGatewayId': 'string',
'directConnectGatewayName': 'string',
'amazonSideAsn': 123,
'ownerAccount': 'string',
'directConnectGatewayState': 'pending'|'available'|'deleting'|'deleted',
'stateChangeError': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Container for the response from the DescribeDirectConnectGateways API call
directConnectGateways (list) --
Information about the direct connect gateways.
(dict) --
A direct connect gateway is an intermediate object that enables you to connect virtual interfaces and virtual private gateways.
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
directConnectGatewayName (string) --
The name of the direct connect gateway.
Example: "My direct connect gateway"
Default: None
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
ownerAccount (string) --
The AWS account ID of the owner of the direct connect gateway.
directConnectGatewayState (string) --
State of the direct connect gateway.
Pending : The initial state after calling CreateDirectConnectGateway .
Available : The direct connect gateway is ready for use.
Deleting : The initial state after calling DeleteDirectConnectGateway .
Deleted : The direct connect gateway is deleted and cannot pass traffic.
stateChangeError (string) --
Error message when the state of an object fails to advance.
nextToken (string) --
Token to retrieve the next page of the result.
Returns a list of all direct connect gateway and virtual private gateway (VGW) associations. Either a direct connect gateway ID or a VGW ID must be provided in the request. If a direct connect gateway ID is provided, the response returns all VGWs associated with the direct connect gateway. If a VGW ID is provided, the response returns all direct connect gateways associated with the VGW. If both are provided, the response only returns the association that matches both the direct connect gateway and the VGW.
See also: AWS API Documentation
Request Syntax
client.describe_direct_connect_gateway_associations(
directConnectGatewayId='string',
virtualGatewayId='string',
maxResults=123,
nextToken='string'
)
string
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
Default: None
string
The ID of the virtual private gateway.
Example: "vgw-abc123ef"
Default: None
integer
The maximum number of direct connect gateway associations to return per page.
Example: 15
Default: None
string
The token provided in the previous describe result to retrieve the next page of the result.
Default: None
dict
Response Syntax
{
'directConnectGatewayAssociations': [
{
'directConnectGatewayId': 'string',
'virtualGatewayId': 'string',
'virtualGatewayRegion': 'string',
'virtualGatewayOwnerAccount': 'string',
'associationState': 'associating'|'associated'|'disassociating'|'disassociated',
'stateChangeError': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Container for the response from the DescribeDirectConnectGatewayAssociations API call
directConnectGatewayAssociations (list) --
Information about the direct connect gateway associations.
(dict) --
The association between a direct connect gateway and virtual private gateway.
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
virtualGatewayId (string) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
virtualGatewayRegion (string) --
The region in which the virtual private gateway is located.
Example: us-east-1
virtualGatewayOwnerAccount (string) --
The AWS account ID of the owner of the virtual private gateway.
associationState (string) --
State of the direct connect gateway association.
Associating : The initial state after calling CreateDirectConnectGatewayAssociation .
Associated : The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.
Disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation .
Disassociated : The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.
stateChangeError (string) --
Error message when the state of an object fails to advance.
nextToken (string) --
Token to retrieve the next page of the result.
{'amazonSideAsn': 'long', 'directConnectGatewayId': 'string'}
Provisions a private virtual interface to be owned by another AWS customer.
Virtual interfaces created using this action must be confirmed by the virtual interface owner by using the ConfirmPrivateVirtualInterface action. Until then, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.
See also: AWS API Documentation
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]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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.
{'amazonSideAsn': 'long', 'directConnectGatewayId': '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.
See also: AWS API Documentation
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]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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.
{'amazonSideAsn': 'long', 'directConnectGatewayId': 'string'}
Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.
Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection .
In order to reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG to which the virtual interface will be newly associated.
See also: AWS API Documentation
Request Syntax
client.associate_virtual_interface(
virtualInterfaceId='string',
connectionId='string'
)
string
[REQUIRED]
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
string
[REQUIRED]
The ID of the LAG or connection with which to associate the virtual interface.
Example: dxlag-abc123 or dxcon-abc123
Default: None
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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.
{'directConnectGatewayId': 'string'}
Accept ownership of a private virtual interface created by another customer.
After the virtual interface owner calls this function, the virtual interface will be created and attached to the given virtual private gateway or direct connect gateway, and will be available for handling traffic.
See also: AWS API Documentation
Request Syntax
client.confirm_private_virtual_interface(
virtualInterfaceId='string',
virtualGatewayId='string',
directConnectGatewayId='string'
)
string
[REQUIRED]
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
string
ID of the virtual private gateway that will be attached to the virtual interface.
A virtual private gateway can be managed via the Amazon Virtual Private Cloud (VPC) console or the EC2 CreateVpnGateway action.
Default: None
string
ID of the direct connect gateway that will be attached to the virtual interface.
A direct connect gateway can be managed via the AWS Direct Connect console or the CreateDirectConnectGateway action.
Default: None
dict
Response Syntax
{
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected'
}
Response Structure
(dict) --
The response received when ConfirmPrivateVirtualInterface is called.
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.
{'virtualInterface': {'amazonSideAsn': 'long',
'directConnectGatewayId': 'string'}}
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.
See also: AWS API Documentation
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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': {'directConnectGatewayId': 'string'}}
Response {'amazonSideAsn': 'long', 'directConnectGatewayId': '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).
See also: AWS API Documentation
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',
'directConnectGatewayId': 'string'
}
)
string
[REQUIRED]
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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) --
The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.
Example: vgw-123er56
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
dict
Response Syntax
{
'ownerAccount': 'string',
'virtualInterfaceId': 'string',
'location': 'string',
'connectionId': 'string',
'virtualInterfaceType': 'string',
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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.
{'amazonSideAsn': 'long', 'directConnectGatewayId': '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.
See also: AWS API Documentation
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]
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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.
{'virtualInterface': {'amazonSideAsn': 'long',
'directConnectGatewayId': 'string'}}
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.
See also: AWS API Documentation
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
The 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,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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': {'amazonSideAsn': 'long',
'directConnectGatewayId': 'string'}}
Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.
A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_interfaces(
connectionId='string',
virtualInterfaceId='string'
)
string
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).
Example: dxcon-fg5678gh
Default: None
string
The 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,
'amazonSideAsn': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualInterfaceState': 'confirming'|'verifying'|'pending'|'available'|'down'|'deleting'|'deleted'|'rejected',
'customerRouterConfig': 'string',
'virtualGatewayId': 'string',
'directConnectGatewayId': '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) --
The ID of the virtual interface.
Example: dxvif-123dfg56
Default: None
location (string) --
Where the connection is located.
Example: EqSV5
Default: None
connectionId (string) --
The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or 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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The 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
directConnectGatewayId (string) --
The ID of the direct connect gateway.
Example: "abcd1234-dcba-5678-be23-cdef9876ab45"
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) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
Example: 65000
authKey (string) --
The 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.