DirectConnect / Client / allocate_public_virtual_interface

allocate_public_virtual_interface#

DirectConnect.Client.allocate_public_virtual_interface(**kwargs)#

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.

Request Syntax

response = 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'
            },
        ]
    }
)

Parameters:

connectionId (string) –
[REQUIRED]

The ID of the connection on which the public virtual interface is provisioned.
ownerAccount (string) –
[REQUIRED]

The ID of the Amazon Web Services account that owns the public virtual interface.
newPublicVirtualInterfaceAllocation (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.

Return type:

dict

Returns:

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, public and transit.
- 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 8500. The default value is 1500
- jumboFrameCapable (boolean) –
  
  Indicates whether jumbo frames 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.

allocate_public_virtual_interface#

Request Syntax

Response Syntax

Response Structure

Exceptions