Interface IDxVirtualInterfaceConfig

NetworkConfig / DxGatewayConfig / DxVirtualInterfaceConfig

Direct Connect (DX) virtual interface (VIF) configuration.

Description

Use this configuration to create a virtual interface to a DX Gateway. Virtual interfaces enable access to your AWS services from your on-premises environment.

The following example creates a transit VIF called Accelerator-VIF in the Network account on a DX connection with resource ID dxcon-example:

Example

- name: Accelerator-VIF
  region: us-east-1
  connectionId: dxcon-example
  customerAsn: 64512
  interfaceName: Accelerator-VIF
  ownerAccount: Network
  type: transit
  vlan: 100
interface IDxVirtualInterfaceConfig {
    addressFamily?: IpVersionType;
    amazonAddress?: string;
    connectionId: string;
    customerAddress?: string;
    customerAsn: number;
    enableSiteLink?: boolean;
    interfaceName: string;
    jumboFrames?: boolean;
    name: string;
    ownerAccount: string;
    region:
        | "af-south-1"
        | "ap-east-1"
        | "ap-northeast-1"
        | "ap-northeast-2"
        | "ap-northeast-3"
        | "ap-south-1"
        | "ap-south-2"
        | "ap-southeast-1"
        | "ap-southeast-2"
        | "ap-southeast-3"
        | "ap-southeast-4"
        | "ap-southeast-5"
        | "ca-central-1"
        | "ca-west-1"
        | "cn-north-1"
        | "cn-northwest-1"
        | "eu-central-1"
        | "eu-central-2"
        | "eu-north-1"
        | "eu-south-1"
        | "eu-south-2"
        | "eu-west-1"
        | "eu-west-2"
        | "eu-west-3"
        | "eu-isoe-west-1"
        | "il-central-1"
        | "me-central-1"
        | "me-south-1"
        | "sa-east-1"
        | "us-east-1"
        | "us-east-2"
        | "us-gov-west-1"
        | "us-gov-east-1"
        | "us-iso-east-1"
        | "us-isob-east-1"
        | "us-iso-west-1"
        | "us-isof-south-1"
        | "us-isof-east-1"
        | "us-west-1"
        | "us-west-2";
    tags?: ITag[];
    type: DxVirtualInterfaceType;
    vlan: number;
}

Properties

addressFamily? amazonAddress? connectionId customerAddress? customerAsn enableSiteLink? interfaceName jumboFrames? name ownerAccount region tags? type vlan

Properties

Optional ReadonlyaddressFamily

addressFamily?: IpVersionType

(OPTIONAL) The address family to use for this virtual interface.

Default - ipv4

Optional ReadonlyamazonAddress

amazonAddress?: string

(OPTIONAL) The peer IP address to use for Amazon's side of the virtual interface.

Default - randomly-generated by Amazon

ReadonlyconnectionId

connectionId: string

The resource ID of the DX connection the virtual interface will be created on

Remarks

This is the resource ID of an existing DX connection in your environment. Resource IDs should be the the format dxcon-xxxxxx

Optional ReadonlycustomerAddress

customerAddress?: string

(OPTIONAL) The peer IP address to use for customer's side of the virtual interface.

Default - randomly-generated by Amazon

ReadonlycustomerAsn

customerAsn: number

A Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the customer side of the connection.

Remarks

This ASN must be unique from the Amazon side ASN. The ASN for the Amazon side is determined by the DX Gateway it is created on.

Note: The valid values are 1 to 2147483647

Optional ReadonlyenableSiteLink

enableSiteLink?: boolean

(OPTIONAL) Enable SiteLink for this virtual interface.

Default - false

ReadonlyinterfaceName

interfaceName: string

The name of the virtual interface. This name will show as the name of the resource in the AWS console and API.

Remarks

This name can be changed without replacing the physical resource.

Optional ReadonlyjumboFrames

jumboFrames?: boolean

(OPTIONAL) Enable jumbo frames for the virtual interface.

Default - standard 1500 MTU frame size

Readonlyname

name: string

A friendly name for the virtual interface. This name is used as a logical reference for the resource in the accelerator.

Remarks

CAUTION: Changing this value after initial deployment will cause the virtual interface to be recreated. Please be aware that any downstream dependencies may cause this property update to fail.

ReadonlyownerAccount

ownerAccount: string

The friendly name of the owning account of the DX connection.

Remarks

Please note this is the owning account of the physical DX connection, not the virtual interface.

If specifying an account that differs from the account of the Direct Connect Gateway, this will create a hosted VIF allocation from the connection owner account to the Direct Connect Gateway owner account. Hosted VIFs must be manually confirmed before they can be used or updated by the accelerator.

Readonlyregion

region:
    | "af-south-1"
    | "ap-east-1"
    | "ap-northeast-1"
    | "ap-northeast-2"
    | "ap-northeast-3"
    | "ap-south-1"
    | "ap-south-2"
    | "ap-southeast-1"
    | "ap-southeast-2"
    | "ap-southeast-3"
    | "ap-southeast-4"
    | "ap-southeast-5"
    | "ca-central-1"
    | "ca-west-1"
    | "cn-north-1"
    | "cn-northwest-1"
    | "eu-central-1"
    | "eu-central-2"
    | "eu-north-1"
    | "eu-south-1"
    | "eu-south-2"
    | "eu-west-1"
    | "eu-west-2"
    | "eu-west-3"
    | "eu-isoe-west-1"
    | "il-central-1"
    | "me-central-1"
    | "me-south-1"
    | "sa-east-1"
    | "us-east-1"
    | "us-east-2"
    | "us-gov-west-1"
    | "us-gov-east-1"
    | "us-iso-east-1"
    | "us-isob-east-1"
    | "us-iso-west-1"
    | "us-isof-south-1"
    | "us-isof-east-1"
    | "us-west-1"
    | "us-west-2"

The region of the virtual interface.

Remarks

Please note this region must match the region where the physical connection is hosted.

Optional Readonlytags

tags?: ITag[]

(OPTIONAL) An array of tags to apply to the virtual interface.

Readonlytype

type: DxVirtualInterfaceType

The type of the virtual interface

Remarks

private virtual interfaces can only be created on DX gateways associated with virtual private gateways.

transit virtual interfaces can only be created on DX gateways associated with transit gateways.

Readonlyvlan

vlan: number

The virtual local area network (VLAN) tag to use for this virtual interface.

Remarks

This must be a unique VLAN tag that's not already in use on your connection.

The value must be between 1 and 4094

Settings

Member Visibility

On This Page

Properties