We are excited to announce our new API Documentation.
Protected
Optional
addressThe address family for the BGP peer.
Optional
amazonThe IP address assigned to the Amazon interface.
Optional
amazonThe autonomous system number (ASN) for the Amazon side of the connection.
Optional
asnThe autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
The valid values are 1-2147483647.
Optional
authThe authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.
Optional
awsThe Direct Connect endpoint that terminates the physical connection.
Optional
awsThe Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Optional
bgpThe BGP peers configured on this virtual interface.
Optional
connectionThe ID of the connection.
Optional
customerThe IP address assigned to the customer interface.
Optional
customerThe customer router configuration.
Optional
directThe ID of the Direct Connect gateway.
Optional
jumboIndicates whether jumbo frames are supported.
Optional
locationThe location of the connection.
Optional
mtuThe maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500
Optional
ownerThe ID of the Amazon Web Services account that owns the virtual interface.
Optional
regionThe Amazon Web Services Region where the virtual interface is located.
Optional
routeThe routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.
Optional
siteIndicates whether SiteLink is enabled.
Optional
tagsThe tags associated with the virtual interface.
Optional
virtualThe ID of the virtual private gateway. Applies only to private virtual interfaces.
Optional
virtualThe ID of the virtual interface.
Optional
virtualThe 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 (-).
Optional
virtualThe 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.
Optional
virtualThe type of virtual interface. The possible values are private
and public
.
Optional
vlanThe ID of the VLAN.
The output of UpdateVirtualInterfaceAttributesCommand.