Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . directconnect ]

create-private-virtual-interface

Description

Creates a new private virtual interface. A virtual interface is the VLAN that transports AWS Direct Connect traffic. A private virtual interface supports sending traffic to a single virtual private cloud (VPC).

See also: AWS API Documentation

Synopsis

  create-private-virtual-interface
--connection-id <value>
--new-private-virtual-interface <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--connection-id (string)

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

--new-private-virtual-interface (structure)

Detailed information for the private virtual interface to be created.

Default: None

Shorthand Syntax:

virtualInterfaceName=string,vlan=integer,asn=integer,authKey=string,amazonAddress=string,customerAddress=string,addressFamily=string,virtualGatewayId=string,directConnectGatewayId=string

JSON Syntax:

{
  "virtualInterfaceName": "string",
  "vlan": integer,
  "asn": integer,
  "authKey": "string",
  "amazonAddress": "string",
  "customerAddress": "string",
  "addressFamily": "ipv4"|"ipv6",
  "virtualGatewayId": "string",
  "directConnectGatewayId": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Examples

To create a private virtual interface

The following create-private-virtual-interface command creates a private virtual interface:

aws directconnect create-private-virtual-interface --connection-id dxcon-ffjrkx17 --new-private-virtual-interface virtualInterfaceName=PrivateVirtualInterface,vlan=101,asn=65000,authKey=asdf34example,amazonAddress=192.168.1.1/30,customerAddress=192.168.1.2/30,virtualGatewayId=vgw-aba37db6

Output:

{
    "virtualInterfaceState": "pending",
    "asn": 65000,
    "vlan": 101,
    "customerAddress": "192.168.1.2/30",
    "ownerAccount": "123456789012",
    "connectionId": "dxcon-ffjrkx17",
    "virtualGatewayId": "vgw-aba37db6",
    "virtualInterfaceId": "dxvif-ffhhk74f",
    "authKey": "asdf34example",
    "routeFilterPrefixes": [],
    "location": "TIVIT",
    "customerRouterConfig": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<logical_connection id=\"dxvif-ffhhk74f\">\n  <vlan>101</vlan>\n  <customer_address>192.168.1.2/30</customer_address>\n  <amazon_address>192.168.1.1/30</amazon_address>\n  <bgp_asn>65000</bgp_asn>\n  <bgp_auth_key>asdf34example</bgp_auth_key>\n  <amazon_bgp_asn>7224</amazon_bgp_asn>\n  <connection_type>private</connection_type>\n</logical_connection>\n",
    "amazonAddress": "192.168.1.1/30",
    "virtualInterfaceType": "private",
    "virtualInterfaceName": "PrivateVirtualInterface"
}

Output

ownerAccount -> (string)

The AWS account that will own the new virtual interface.

virtualInterfaceId -> (string)

The ID of the virtual interface.

Example: dxvif-123dfg56

Default: None

location -> (string)

Where the connection is located.

Example: EqSV5

Default: None

connectionId -> (string)

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

virtualInterfaceType -> (string)

The type of virtual interface.

Example: private (Amazon VPC) or public (Amazon S3, Amazon DynamoDB, and so on.)

virtualInterfaceName -> (string)

The name of the virtual interface assigned by the customer.

Example: "My VPC"

vlan -> (integer)

The VLAN ID.

Example: 101

asn -> (integer)

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

Example: 65000

amazonSideAsn -> (long)

The autonomous system number (ASN) for the Amazon side of the connection.

authKey -> (string)

The authentication key for BGP configuration.

Example: asdf34example

amazonAddress -> (string)

IP address assigned to the Amazon interface.

Example: 192.168.1.1/30 or 2001:db8::1/125

customerAddress -> (string)

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

addressFamily -> (string)

Indicates the address family for the BGP peer.

  • ipv4 : IPv4 address family
  • ipv6 : IPv6 address family

virtualInterfaceState -> (string)

State of the virtual interface.

  • Confirming : The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.
  • Verifying : This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.
  • Pending : A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.
  • Available : A virtual interface that is able to forward traffic.
  • Down : A virtual interface that is BGP down.
  • Deleting : A virtual interface is in this state immediately after calling delete-virtual-interface until it can no longer forward traffic.
  • Deleted : A virtual interface that cannot forward traffic.
  • Rejected : The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.

customerRouterConfig -> (string)

Information for generating the customer router configuration.

virtualGatewayId -> (string)

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Example: vgw-123er56

directConnectGatewayId -> (string)

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

routeFilterPrefixes -> (list)

A list of routes to be advertised to the AWS network in this region (public virtual interface).

(structure)

A route filter prefix that the customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

cidr -> (string)

CIDR notation for the advertised route. Multiple routes are separated by commas.

IPv6 CIDRs must be at least a /64 or shorter

Example: 10.10.10.0/24,10.10.11.0/24,2001:db8::/64

bgpPeers -> (list)

A list of the BGP peers configured on this virtual interface.

(structure)

A structure containing information about a BGP peer.

asn -> (integer)

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

Example: 65000

authKey -> (string)

The authentication key for BGP configuration.

Example: asdf34example

addressFamily -> (string)

Indicates the address family for the BGP peer.

  • ipv4 : IPv4 address family
  • ipv6 : IPv6 address family

amazonAddress -> (string)

IP address assigned to the Amazon interface.

Example: 192.168.1.1/30 or 2001:db8::1/125

customerAddress -> (string)

IP address assigned to the customer interface.

Example: 192.168.1.2/30 or 2001:db8::2/125

bgpPeerState -> (string)

The state of the BGP peer.

  • Verifying : The BGP peering addresses or ASN require validation before the BGP peer can be created. This state only applies to BGP peers on a public virtual interface.
  • Pending : The BGP peer has been created, and is in this state until it is ready to be established.
  • Available : The BGP peer can be established.
  • Deleting : The BGP peer is in the process of being deleted.
  • Deleted : The BGP peer has been deleted and cannot be established.

bgpStatus -> (string)

The Up/Down state of the BGP peer.

  • Up : The BGP peer is established.
  • Down : The BGP peer is down.