Skip to content

Resource: awsDxTransitVirtualInterface

Provides a Direct Connect transit virtual interface resource. A transit virtual interface is a VLAN that transports traffic from a Direct Connect gateway to one or more transit gateways.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
const awsDxGatewayExample = new aws.dxGateway.DxGateway(this, "example", {
  amazonSideAsn: 64512,
  name: "tf-dxg-example",
});
const awsDxTransitVirtualInterfaceExample =
  new aws.dxTransitVirtualInterface.DxTransitVirtualInterface(
    this,
    "example_1",
    {
      addressFamily: "ipv4",
      bgpAsn: 65352,
      connectionId: "${aws_dx_connection.example.id}",
      dxGatewayId: awsDxGatewayExample.id,
      name: "tf-transit-vif-example",
      vlan: 4094,
    }
  );
/*This allows the Terraform resource name to match the original name. You can remove the call if you don't need them to match.*/
awsDxTransitVirtualInterfaceExample.overrideLogicalId("example");

Argument Reference

The following arguments are supported:

  • addressFamily - (Required) The address family for the BGP peer. ipv4 or ipv6.
  • bgpAsn - (Required) The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
  • connectionId - (Required) The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
  • dxGatewayId - (Required) The ID of the Direct Connect gateway to which to connect the virtual interface.
  • name - (Required) The name for the virtual interface.
  • vlan - (Required) The VLAN ID.
  • amazonAddress - (Optional) The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
  • bgpAuthKey - (Optional) The authentication key for BGP configuration.
  • customerAddress - (Optional) The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
  • mtu - (Optional) The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection. The MTU of a virtual transit interface can be either 1500 or 8500 (jumbo frames). Default is 1500.
  • sitelinkEnabled - (Optional) Indicates whether to enable or disable SiteLink.
  • tags - (Optional) A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

  • id - The ID of the virtual interface.
  • arn - The ARN of the virtual interface.
  • awsDevice - The Direct Connect endpoint on which the virtual interface terminates.
  • jumboFrameCapable - Indicates whether jumbo frames (8500 MTU) are supported.
  • tagsAll - A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

Timeouts

Configuration options:

  • create - (Default 10M)
  • update - (Default 10M)
  • delete - (Default 10M)

Import

Direct Connect transit virtual interfaces can be imported using the vifId, e.g.,

$ terraform import aws_dx_transit_virtual_interface.test dxvif-33cc44dd