Skip to content

Updates the specified attributes of the specified virtual private interface

Description

Updates the specified attributes of the specified virtual private interface.

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 describe_connections. To check whether your virtual interface supports jumbo frames, call describe_virtual_interfaces.

Usage

directconnect_update_virtual_interface_attributes(virtualInterfaceId,
  mtu, enableSiteLink, virtualInterfaceName, prefixPoolAllocatedCountIpv4,
  prefixPoolAllocatedCountIpv6, rateLimit)

Arguments

  • virtualInterfaceId

[required] The ID of the virtual private interface.

  • mtu

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

  • enableSiteLink

Indicates whether to enable or disable SiteLink.

  • virtualInterfaceName

The name of the virtual private interface.

  • prefixPoolAllocatedCountIpv4

The number of inbound IPv4 route prefixes to allocate to the virtual interface. Not applicable to public virtual interfaces.

  • prefixPoolAllocatedCountIpv6

The number of inbound IPv6 route prefixes to allocate to the virtual interface. Not applicable to public virtual interfaces.

  • rateLimit

The rate limit (bandwidth allocation) to apply to the virtual interface. Use this to update the bandwidth allocation on an existing virtual interface.

Value

A list with the following syntax:

list(
  ownerAccount = "string",
  virtualInterfaceId = "string",
  location = "string",
  connectionId = "string",
  virtualInterfaceType = "string",
  virtualInterfaceName = "string",
  vlan = 123,
  asn = 123,
  asnLong = 123,
  amazonSideAsn = 123,
  authKey = "string",
  amazonAddress = "string",
  customerAddress = "string",
  addressFamily = "ipv4"|"ipv6",
  virtualInterfaceState = "confirming"|"verifying"|"pending"|"available"|"down"|"testing"|"deleting"|"deleted"|"rejected"|"unknown",
  customerRouterConfig = "string",
  mtu = 123,
  jumboFrameCapable = TRUE|FALSE,
  virtualGatewayId = "string",
  directConnectGatewayId = "string",
  routeFilterPrefixes = list(
    list(
      cidr = "string"
    )
  ),
  bgpPeers = list(
    list(
      bgpPeerId = "string",
      asn = 123,
      asnLong = 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 = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  siteLinkEnabled = TRUE|FALSE,
  prefixPoolAllocatedCountIpv4 = 123,
  prefixPoolAllocatedCountIpv6 = 123,
  rateLimit = "string"
)

Request syntax

svc$update_virtual_interface_attributes(
  virtualInterfaceId = "string",
  mtu = 123,
  enableSiteLink = TRUE|FALSE,
  virtualInterfaceName = "string",
  prefixPoolAllocatedCountIpv4 = 123,
  prefixPoolAllocatedCountIpv6 = 123,
  rateLimit = "string"
)