2021/12/01 - AWS Direct Connect - 11 updated api methods
Changes Adds SiteLink support to private and transit virtual interfaces. SiteLink is a new Direct Connect feature that allows routing between Direct Connect points of presence.
{'siteLinkEnabled': 'boolean'}
Provisions a private virtual interface to be owned by the specified Amazon Web Services account.
Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface . Until then, the virtual interface is in the Confirming state and is not available to handle traffic.
See also: AWS API Documentation
Request Syntax
client.allocate_private_virtual_interface(
connectionId='string',
ownerAccount='string',
newPrivateVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'customerAddress': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection on which the private virtual interface is provisioned.
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the virtual private interface.
dict
[REQUIRED]
Information about the private virtual interface.
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]
The ID of the VLAN.
asn (integer) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
addressFamily (string) --
The address family for the BGP peer.
customerAddress (string) --
The IP address assigned to the customer interface.
tags (list) --
The tags associated with the private virtual interface.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'siteLinkEnabled': 'boolean'}
Provisions a public virtual interface to be owned by the specified Amazon Web Services account.
The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.
Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface . Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.
When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.
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'
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection on which the public virtual interface is provisioned.
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the public virtual interface.
dict
[REQUIRED]
Information about the public virtual interface.
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]
The ID of the VLAN.
asn (integer) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
tags (list) --
The tags associated with the public virtual interface.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'virtualInterface': {'siteLinkEnabled': 'boolean'}}
Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.
The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.
After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface . Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.
See also: AWS API Documentation
Request Syntax
client.allocate_transit_virtual_interface(
connectionId='string',
ownerAccount='string',
newTransitVirtualInterfaceAllocation={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection on which the transit virtual interface is provisioned.
string
[REQUIRED]
The ID of the Amazon Web Services account that owns the transit virtual interface.
dict
[REQUIRED]
Information about the transit virtual interface.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
tags (list) --
The tags associated with the transitive virtual interface.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'siteLinkEnabled': 'boolean'}
Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services 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 .
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 for the association.
See also: AWS API Documentation
Request Syntax
client.associate_virtual_interface(
virtualInterfaceId='string',
connectionId='string'
)
string
[REQUIRED]
The ID of the virtual interface.
string
[REQUIRED]
The ID of the LAG or connection.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'virtualInterface': {'siteLinkEnabled': 'boolean'}}
Creates a BGP peer on the specified virtual interface.
You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.
If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.
When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon 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 on the allow list 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.
dict
Information about the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
The virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'newPrivateVirtualInterface': {'enableSiteLink': 'boolean'}}
Response {'siteLinkEnabled': 'boolean'}
Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections . To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces .
See also: AWS API Documentation
Request Syntax
client.create_private_virtual_interface(
connectionId='string',
newPrivateVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'enableSiteLink': True|False
}
)
string
[REQUIRED]
The ID of the connection.
dict
[REQUIRED]
Information about the private virtual interface.
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]
The ID of the VLAN.
asn (integer) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualGatewayId (string) --
The ID of the virtual private gateway.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
tags (list) --
The tags associated with the private virtual interface.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
enableSiteLink (boolean) --
Indicates whether to enable or disable SiteLink.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'siteLinkEnabled': 'boolean'}
Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.
When creating an IPv6 public virtual interface (addressFamily is ipv6 ), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are 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'
},
],
'tags': [
{
'key': 'string',
'value': 'string'
},
]
}
)
string
[REQUIRED]
The ID of the connection.
dict
[REQUIRED]
Information about the public virtual interface.
virtualInterfaceName (string) -- [REQUIRED]
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) -- [REQUIRED]
The ID of the VLAN.
asn (integer) -- [REQUIRED]
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
tags (list) --
The tags associated with the public virtual interface.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'newTransitVirtualInterface': {'enableSiteLink': 'boolean'}}
Response {'virtualInterface': {'siteLinkEnabled': 'boolean'}}
Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.
Warning
If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.
Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections . To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces .
See also: AWS API Documentation
Request Syntax
client.create_transit_virtual_interface(
connectionId='string',
newTransitVirtualInterface={
'virtualInterfaceName': 'string',
'vlan': 123,
'asn': 123,
'mtu': 123,
'authKey': 'string',
'amazonAddress': 'string',
'customerAddress': 'string',
'addressFamily': 'ipv4'|'ipv6',
'directConnectGatewayId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'enableSiteLink': True|False
}
)
string
[REQUIRED]
The ID of the connection.
dict
[REQUIRED]
Information about the transit virtual interface.
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
tags (list) --
The tags associated with the transitive virtual interface.
(dict) --
Information about a tag.
key (string) -- [REQUIRED]
The key.
value (string) --
The value.
enableSiteLink (boolean) --
Indicates whether to enable or disable SiteLink.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'virtualInterface': {'siteLinkEnabled': 'boolean'}}
Deletes the specified BGP peer on the specified virtual interface with 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',
bgpPeerId='string'
)
string
The ID of the virtual interface.
integer
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
string
The IP address assigned to the customer interface.
string
The ID of the BGP peer.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
}
Response Structure
(dict) --
virtualInterface (dict) --
The virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'virtualInterfaces': {'siteLinkEnabled': 'boolean'}}
Displays all virtual interfaces for an Amazon Web Services 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 Direct Connect location and the customer network.
See also: AWS API Documentation
Request Syntax
client.describe_virtual_interfaces(
connectionId='string',
virtualInterfaceId='string'
)
string
The ID of the connection.
string
The ID of the virtual interface.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
},
]
}
Response Structure
(dict) --
virtualInterfaces (list) --
The virtual interfaces
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.
{'enableSiteLink': 'boolean', 'virtualInterfaceName': 'string'}
Response {'siteLinkEnabled': 'boolean'}
Updates the specified attributes of the specified virtual private interface.
Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections . To check whether your virtual q interface supports jumbo frames, call DescribeVirtualInterfaces .
See also: AWS API Documentation
Request Syntax
client.update_virtual_interface_attributes(
virtualInterfaceId='string',
mtu=123,
enableSiteLink=True|False,
virtualInterfaceName='string'
)
string
[REQUIRED]
The ID of the virtual private interface.
integer
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
boolean
Indicates whether to enable or disable SiteLink.
string
The name of the virtual private interface.
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'|'unknown',
'customerRouterConfig': 'string',
'mtu': 123,
'jumboFrameCapable': True|False,
'virtualGatewayId': 'string',
'directConnectGatewayId': 'string',
'routeFilterPrefixes': [
{
'cidr': 'string'
},
],
'bgpPeers': [
{
'bgpPeerId': 'string',
'asn': 123,
'authKey': 'string',
'addressFamily': 'ipv4'|'ipv6',
'amazonAddress': 'string',
'customerAddress': 'string',
'bgpPeerState': 'verifying'|'pending'|'available'|'deleting'|'deleted',
'bgpStatus': 'up'|'down'|'unknown',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string'
},
],
'region': 'string',
'awsDeviceV2': 'string',
'awsLogicalDeviceId': 'string',
'tags': [
{
'key': 'string',
'value': 'string'
},
],
'siteLinkEnabled': True|False
}
Response Structure
(dict) --
Information about a virtual interface.
ownerAccount (string) --
The ID of the Amazon Web Services account that owns the virtual interface.
virtualInterfaceId (string) --
The ID of the virtual interface.
location (string) --
The location of the connection.
connectionId (string) --
The ID of the connection.
virtualInterfaceType (string) --
The type of virtual interface. The possible values are private and public .
virtualInterfaceName (string) --
The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
vlan (integer) --
The ID of the VLAN.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
amazonSideAsn (integer) --
The autonomous system number (ASN) for the Amazon side of the connection.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
addressFamily (string) --
The address family for the BGP peer.
virtualInterfaceState (string) --
The state of the virtual interface. The following are the possible values:
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 enters the Rejected state.
unknown : The state of the virtual interface is not available.
customerRouterConfig (string) --
The customer router configuration.
mtu (integer) --
The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
jumboFrameCapable (boolean) --
Indicates whether jumbo frames (9001 MTU) are supported.
virtualGatewayId (string) --
The ID of the virtual private gateway. Applies only to private virtual interfaces.
directConnectGatewayId (string) --
The ID of the Direct Connect gateway.
routeFilterPrefixes (list) --
The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
(dict) --
Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.
cidr (string) --
The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.
bgpPeers (list) --
The BGP peers configured on this virtual interface.
(dict) --
Information about a BGP peer.
bgpPeerId (string) --
The ID of the BGP peer.
asn (integer) --
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
authKey (string) --
The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
addressFamily (string) --
The address family for the BGP peer.
amazonAddress (string) --
The IP address assigned to the Amazon interface.
customerAddress (string) --
The IP address assigned to the customer interface.
bgpPeerState (string) --
The state of the BGP peer. The following are the possible values:
verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state applies only to public virtual interfaces.
pending : The BGP peer is created, and remains in this state until it is ready to be established.
available : The BGP peer is ready to be established.
deleting : The BGP peer is being deleted.
deleted : The BGP peer is deleted and cannot be established.
bgpStatus (string) --
The status of the BGP peer. The following are the possible values:
up : The BGP peer is established. This state does not indicate the state of the routing function. Ensure that you are receiving routes over the BGP session.
down : The BGP peer is down.
unknown : The BGP peer status is not available.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the BGP peer.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
region (string) --
The Amazon Web Services Region where the virtual interface is located.
awsDeviceV2 (string) --
The Direct Connect endpoint that terminates the physical connection.
awsLogicalDeviceId (string) --
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
tags (list) --
The tags associated with the virtual interface.
(dict) --
Information about a tag.
key (string) --
The key.
value (string) --
The value.
siteLinkEnabled (boolean) --
Indicates whether SiteLink is enabled.