Allocate Private Virtual Interface

directconnect_allocate_private_virtual_interface

R Documentation

Provisions a private virtual interface to be owned by the specified Amazon Web Services account¶

Description¶

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 confirm_private_virtual_interface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

Usage¶

directconnect_allocate_private_virtual_interface(connectionId,
  ownerAccount, newPrivateVirtualInterfaceAllocation)

Arguments¶

connectionId: [required] The ID of the connection on which the private virtual interface is provisioned.
ownerAccount: [required] The ID of the Amazon Web Services account that owns the virtual private interface.
newPrivateVirtualInterfaceAllocation: [required] Information about the private 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,
  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 = list(
    list(
      cidr = "string"
    )
  ),
  bgpPeers = list(
    list(
      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 = list(
    list(
      key = "string",
      value = "string"
    )
  ),
  siteLinkEnabled = TRUE|FALSE
)

Request syntax¶

svc$allocate_private_virtual_interface(
  connectionId = "string",
  ownerAccount = "string",
  newPrivateVirtualInterfaceAllocation = list(
    virtualInterfaceName = "string",
    vlan = 123,
    asn = 123,
    mtu = 123,
    authKey = "string",
    amazonAddress = "string",
    addressFamily = "ipv4"|"ipv6",
    customerAddress = "string",
    tags = list(
      list(
        key = "string",
        value = "string"
      )
    )
  )
)