VirtualInterface#

Contains information about a virtual interface and is used as a response element in the following methods:

Contents#

  • addressFamily — The type of IP address.

    • Type: String

    • Required: Yes

    • Valid values: ipv4

  • amazonAddress — The cloud-side IP address for BGP peering.

    • Type: String

    • Required: Yes

    • Constraints: The IP address must be in the subnet 169.254.252.0/22

  • asn — The client-side BGP ASN.

    • Type: Integer

    • Required: Yes

    • Constraints: It should differ from the BGP ASN of the Direct Connect gateway

  • authKey — The authentication key in the BGP configuration.

    • Type: String

    • Required: No

  • awsDeviceV2 — The ID of the device where a dedicated connection between the corporate network and the cloud data center is terminated.

    • Type: String

    • Required: Yes

  • connectionId — The connection ID.

    • Type: String

    • Required: Yes

  • customerAddress — The client-side IP address for BGP peering.

    • Type: String

    • Required: Yes

    • Constraints: The IP address must be in the subnet 169.254.252.0/22

  • directConnectGatewayId — The ID of the Direct Connect gateway.

    • Type: String

    • Required: Yes

  • location — The location of the virtual interface.

    • Type: String

    • Required: Yes

  • ownerAccount — The project that owns the virtual interface.

    • Type: String

    • Required: Yes

  • virtualInterfaceId — The ID of the virtual interface.

    • Type: String

    • Required: Yes

  • virtualInterfaceName — The name of the virtual interface.

    • Type: String

    • Required: Yes

  • virtualInterfaceState — The state of the virtual interface.

    • Type: String

    • Required: Yes

    • Valid values: available

  • virtualInterfaceType — The type of the virtual interface.

    • Type: String

    • Required: Yes

    • Valid values: transit

  • vlan — The ID of the VLAN.

    • Type: Integer

    • Required: Yes