Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS
  4. API Docs
  5. directconnect
  6. TransitVirtualInterface
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.directconnect.TransitVirtualInterface

aws logo aws logo
Viewing docs for AWS v7.46.0
published on Thursday, Sep 10, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    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

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.directconnect.Gateway("example", {
    name: "tf-dxg-example",
    amazonSideAsn: "64512",
});
const exampleTransitVirtualInterface = new aws.directconnect.TransitVirtualInterface("example", {
    connectionId: exampleAwsDxConnection.id,
    dxGatewayId: example.id,
    name: "tf-transit-vif-example",
    vlan: 4094,
    addressFamily: "ipv4",
    bgpAsn: 65352,
});

    import pulumi
import pulumi_aws as aws

example = aws.directconnect.Gateway("example",
    name="tf-dxg-example",
    amazon_side_asn="64512")
example_transit_virtual_interface = aws.directconnect.TransitVirtualInterface("example",
    connection_id=example_aws_dx_connection["id"],
    dx_gateway_id=example.id,
    name="tf-transit-vif-example",
    vlan=4094,
    address_family="ipv4",
    bgp_asn=65352)

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/directconnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := directconnect.NewGateway(ctx, "example", &directconnect.GatewayArgs{
			Name:          pulumi.String("tf-dxg-example"),
			AmazonSideAsn: pulumi.String("64512"),
		})
		if err != nil {
			return err
		}
		_, err = directconnect.NewTransitVirtualInterface(ctx, "example", &directconnect.TransitVirtualInterfaceArgs{
			ConnectionId:  pulumi.Any(exampleAwsDxConnection.Id),
			DxGatewayId:   example.ID().ToIDOutput().ToStringOutput(),
			Name:          pulumi.String("tf-transit-vif-example"),
			Vlan:          pulumi.Int(4094),
			AddressFamily: pulumi.String("ipv4"),
			BgpAsn:        pulumi.Int(65352),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.DirectConnect.Gateway("example", new()
    {
        Name = "tf-dxg-example",
        AmazonSideAsn = "64512",
    });

    var exampleTransitVirtualInterface = new Aws.DirectConnect.TransitVirtualInterface("example", new()
    {
        ConnectionId = exampleAwsDxConnection.Id,
        DxGatewayId = example.Id,
        Name = "tf-transit-vif-example",
        Vlan = 4094,
        AddressFamily = "ipv4",
        BgpAsn = 65352,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.Gateway;
import com.pulumi.aws.directconnect.GatewayArgs;
import com.pulumi.aws.directconnect.TransitVirtualInterface;
import com.pulumi.aws.directconnect.TransitVirtualInterfaceArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Gateway("example", GatewayArgs.builder()
            .name("tf-dxg-example")
            .amazonSideAsn("64512")
            .build());

        var exampleTransitVirtualInterface = new TransitVirtualInterface("exampleTransitVirtualInterface", TransitVirtualInterfaceArgs.builder()
            .connectionId(exampleAwsDxConnection.id())
            .dxGatewayId(example.id())
            .name("tf-transit-vif-example")
            .vlan(4094)
            .addressFamily("ipv4")
            .bgpAsn(65352)
            .build());

    }
}

    resources:
  example:
    type: aws:directconnect:Gateway
    properties:
      name: tf-dxg-example
      amazonSideAsn: 64512
  exampleTransitVirtualInterface:
    type: aws:directconnect:TransitVirtualInterface
    name: example
    properties:
      connectionId: ${exampleAwsDxConnection.id}
      dxGatewayId: ${example.id}
      name: tf-transit-vif-example
      vlan: 4094
      addressFamily: ipv4
      bgpAsn: 65352

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_directconnect_gateway" "example" {
  name            = "tf-dxg-example"
  amazon_side_asn = 64512
}
resource "aws_directconnect_transitvirtualinterface" "example" {
  connection_id  = exampleAwsDxConnection.id
  dx_gateway_id  = aws_directconnect_gateway.example.id
  name           = "tf-transit-vif-example"
  vlan           = 4094
  address_family = "ipv4"
  bgp_asn        = 65352
}

    Create TransitVirtualInterface Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TransitVirtualInterface(name: string, args: TransitVirtualInterfaceArgs, opts?: CustomResourceOptions);
    @overload
def TransitVirtualInterface(resource_name: str,
                            args: TransitVirtualInterfaceArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def TransitVirtualInterface(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            connection_id: Optional[str] = None,
                            vlan: Optional[int] = None,
                            address_family: Optional[str] = None,
                            dx_gateway_id: Optional[str] = None,
                            mtu: Optional[int] = None,
                            bgp_auth_key: Optional[str] = None,
                            customer_address: Optional[str] = None,
                            bgp_asn_long: Optional[str] = None,
                            bgp_asn: Optional[int] = None,
                            name: Optional[str] = None,
                            prefix_pool_allocated_count_ipv4: Optional[int] = None,
                            prefix_pool_allocated_count_ipv6: Optional[int] = None,
                            rate_limit: Optional[str] = None,
                            region: Optional[str] = None,
                            sitelink_enabled: Optional[bool] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            amazon_address: Optional[str] = None)
    func NewTransitVirtualInterface(ctx *Context, name string, args TransitVirtualInterfaceArgs, opts ...ResourceOption) (*TransitVirtualInterface, error)
    public TransitVirtualInterface(string name, TransitVirtualInterfaceArgs args, CustomResourceOptions? opts = null)
    public TransitVirtualInterface(String name, TransitVirtualInterfaceArgs args)
public TransitVirtualInterface(String name, TransitVirtualInterfaceArgs args, CustomResourceOptions options)

    type: aws:directconnect:TransitVirtualInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_directconnect_transit_virtual_interface" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args TransitVirtualInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TransitVirtualInterfaceArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TransitVirtualInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TransitVirtualInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TransitVirtualInterfaceArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var transitVirtualInterfaceResource = new Aws.DirectConnect.TransitVirtualInterface("transitVirtualInterfaceResource", new()
{
    ConnectionId = "string",
    Vlan = 0,
    AddressFamily = "string",
    DxGatewayId = "string",
    Mtu = 0,
    BgpAuthKey = "string",
    CustomerAddress = "string",
    BgpAsnLong = "string",
    BgpAsn = 0,
    Name = "string",
    PrefixPoolAllocatedCountIpv4 = 0,
    PrefixPoolAllocatedCountIpv6 = 0,
    RateLimit = "string",
    Region = "string",
    SitelinkEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    AmazonAddress = "string",
});

    example, err := directconnect.NewTransitVirtualInterface(ctx, "transitVirtualInterfaceResource", &directconnect.TransitVirtualInterfaceArgs{
	ConnectionId:                 pulumi.String("string"),
	Vlan:                         pulumi.Int(0),
	AddressFamily:                pulumi.String("string"),
	DxGatewayId:                  pulumi.String("string"),
	Mtu:                          pulumi.Int(0),
	BgpAuthKey:                   pulumi.String("string"),
	CustomerAddress:              pulumi.String("string"),
	BgpAsnLong:                   pulumi.String("string"),
	BgpAsn:                       pulumi.Int(0),
	Name:                         pulumi.String("string"),
	PrefixPoolAllocatedCountIpv4: pulumi.Int(0),
	PrefixPoolAllocatedCountIpv6: pulumi.Int(0),
	RateLimit:                    pulumi.String("string"),
	Region:                       pulumi.String("string"),
	SitelinkEnabled:              pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AmazonAddress: pulumi.String("string"),
})

    resource "aws_directconnect_transit_virtual_interface" "transitVirtualInterfaceResource" {
  lifecycle {
    create_before_destroy = true
  }
  connection_id                    = "string"
  vlan                             = 0
  address_family                   = "string"
  dx_gateway_id                    = "string"
  mtu                              = 0
  bgp_auth_key                     = "string"
  customer_address                 = "string"
  bgp_asn_long                     = "string"
  bgp_asn                          = 0
  name                             = "string"
  prefix_pool_allocated_count_ipv4 = 0
  prefix_pool_allocated_count_ipv6 = 0
  rate_limit                       = "string"
  region                           = "string"
  sitelink_enabled                 = false
  tags = {
    "string" = "string"
  }
  amazon_address = "string"
}

    var transitVirtualInterfaceResource = new TransitVirtualInterface("transitVirtualInterfaceResource", TransitVirtualInterfaceArgs.builder()
    .connectionId("string")
    .vlan(0)
    .addressFamily("string")
    .dxGatewayId("string")
    .mtu(0)
    .bgpAuthKey("string")
    .customerAddress("string")
    .bgpAsnLong("string")
    .bgpAsn(0)
    .name("string")
    .prefixPoolAllocatedCountIpv4(0)
    .prefixPoolAllocatedCountIpv6(0)
    .rateLimit("string")
    .region("string")
    .sitelinkEnabled(false)
    .tags(Map.of("string", "string"))
    .amazonAddress("string")
    .build());

    transit_virtual_interface_resource = aws.directconnect.TransitVirtualInterface("transitVirtualInterfaceResource",
    connection_id="string",
    vlan=0,
    address_family="string",
    dx_gateway_id="string",
    mtu=0,
    bgp_auth_key="string",
    customer_address="string",
    bgp_asn_long="string",
    bgp_asn=0,
    name="string",
    prefix_pool_allocated_count_ipv4=0,
    prefix_pool_allocated_count_ipv6=0,
    rate_limit="string",
    region="string",
    sitelink_enabled=False,
    tags={
        "string": "string",
    },
    amazon_address="string")

    const transitVirtualInterfaceResource = new aws.directconnect.TransitVirtualInterface("transitVirtualInterfaceResource", {
    connectionId: "string",
    vlan: 0,
    addressFamily: "string",
    dxGatewayId: "string",
    mtu: 0,
    bgpAuthKey: "string",
    customerAddress: "string",
    bgpAsnLong: "string",
    bgpAsn: 0,
    name: "string",
    prefixPoolAllocatedCountIpv4: 0,
    prefixPoolAllocatedCountIpv6: 0,
    rateLimit: "string",
    region: "string",
    sitelinkEnabled: false,
    tags: {
        string: "string",
    },
    amazonAddress: "string",
});

    type: aws:directconnect:TransitVirtualInterface
properties:
    addressFamily: string
    amazonAddress: string
    bgpAsn: 0
    bgpAsnLong: string
    bgpAuthKey: string
    connectionId: string
    customerAddress: string
    dxGatewayId: string
    mtu: 0
    name: string
    prefixPoolAllocatedCountIpv4: 0
    prefixPoolAllocatedCountIpv6: 0
    rateLimit: string
    region: string
    sitelinkEnabled: false
    tags:
        string: string
    vlan: 0

    TransitVirtualInterface Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The TransitVirtualInterface resource accepts the following input properties:

    AddressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    ConnectionId string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    DxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    Vlan int
    The VLAN ID.
    AmazonAddress string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    BgpAsn int
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAsnLong string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAuthKey string
    The authentication key for BGP configuration.
    CustomerAddress string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    Mtu int
    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.
    Name string
    The name for the virtual interface.
    PrefixPoolAllocatedCountIpv4 int
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    PrefixPoolAllocatedCountIpv6 int
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    RateLimit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SitelinkEnabled bool
    Indicates whether to enable or disable SiteLink.
    Tags Dictionary<string, string>
    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.
    AddressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    ConnectionId string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    DxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    Vlan int
    The VLAN ID.
    AmazonAddress string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    BgpAsn int
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAsnLong string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAuthKey string
    The authentication key for BGP configuration.
    CustomerAddress string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    Mtu int
    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.
    Name string
    The name for the virtual interface.
    PrefixPoolAllocatedCountIpv4 int
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    PrefixPoolAllocatedCountIpv6 int
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    RateLimit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SitelinkEnabled bool
    Indicates whether to enable or disable SiteLink.
    Tags map[string]string
    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.
    address_family string
    The address family for the BGP peer. ipv4 or ipv6.
    connection_id string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    dx_gateway_id string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    vlan number
    The VLAN ID.
    amazon_address string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    bgp_asn number
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_asn_long string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_auth_key string
    The authentication key for BGP configuration.
    customer_address string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    mtu number
    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.
    name string
    The name for the virtual interface.
    prefix_pool_allocated_count_ipv4 number
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefix_pool_allocated_count_ipv6 number
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rate_limit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelink_enabled bool
    Indicates whether to enable or disable SiteLink.
    tags map(string)
    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.
    addressFamily String
    The address family for the BGP peer. ipv4 or ipv6.
    connectionId String
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    dxGatewayId String
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    vlan Integer
    The VLAN ID.
    amazonAddress String
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    bgpAsn Integer
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAsnLong String
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAuthKey String
    The authentication key for BGP configuration.
    customerAddress String
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    mtu Integer
    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.
    name String
    The name for the virtual interface.
    prefixPoolAllocatedCountIpv4 Integer
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefixPoolAllocatedCountIpv6 Integer
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rateLimit String
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelinkEnabled Boolean
    Indicates whether to enable or disable SiteLink.
    tags Map<String,String>
    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.
    addressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    connectionId string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    dxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    vlan number
    The VLAN ID.
    amazonAddress string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    bgpAsn number
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAsnLong string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAuthKey string
    The authentication key for BGP configuration.
    customerAddress string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    mtu number
    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.
    name string
    The name for the virtual interface.
    prefixPoolAllocatedCountIpv4 number
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefixPoolAllocatedCountIpv6 number
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rateLimit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelinkEnabled boolean
    Indicates whether to enable or disable SiteLink.
    tags {[key: string]: string}
    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.
    address_family str
    The address family for the BGP peer. ipv4 or ipv6.
    connection_id str
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    dx_gateway_id str
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    vlan int
    The VLAN ID.
    amazon_address str
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    bgp_asn int
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_asn_long str
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_auth_key str
    The authentication key for BGP configuration.
    customer_address str
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    mtu int
    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.
    name str
    The name for the virtual interface.
    prefix_pool_allocated_count_ipv4 int
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefix_pool_allocated_count_ipv6 int
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rate_limit str
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelink_enabled bool
    Indicates whether to enable or disable SiteLink.
    tags Mapping[str, str]
    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.
    addressFamily String
    The address family for the BGP peer. ipv4 or ipv6.
    connectionId String
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    dxGatewayId String
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    vlan Number
    The VLAN ID.
    amazonAddress String
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    bgpAsn Number
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAsnLong String
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAuthKey String
    The authentication key for BGP configuration.
    customerAddress String
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    mtu Number
    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.
    name String
    The name for the virtual interface.
    prefixPoolAllocatedCountIpv4 Number
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefixPoolAllocatedCountIpv6 Number
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rateLimit String
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelinkEnabled Boolean
    Indicates whether to enable or disable SiteLink.
    tags Map<String>
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the TransitVirtualInterface resource produces the following output properties:

    AmazonSideAsn string
    Arn string
    The ARN of the virtual interface.
    AwsDevice string
    The Direct Connect endpoint on which the virtual interface terminates.
    Id string
    The provider-assigned unique ID for this managed resource.
    JumboFrameCapable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    AmazonSideAsn string
    Arn string
    The ARN of the virtual interface.
    AwsDevice string
    The Direct Connect endpoint on which the virtual interface terminates.
    Id string
    The provider-assigned unique ID for this managed resource.
    JumboFrameCapable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    amazon_side_asn string
    arn string
    The ARN of the virtual interface.
    aws_device string
    The Direct Connect endpoint on which the virtual interface terminates.
    id string
    The provider-assigned unique ID for this managed resource.
    jumbo_frame_capable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    tags_all map(string)
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    amazonSideAsn String
    arn String
    The ARN of the virtual interface.
    awsDevice String
    The Direct Connect endpoint on which the virtual interface terminates.
    id String
    The provider-assigned unique ID for this managed resource.
    jumboFrameCapable Boolean
    Indicates whether jumbo frames (8500 MTU) are supported.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    amazonSideAsn string
    arn string
    The ARN of the virtual interface.
    awsDevice string
    The Direct Connect endpoint on which the virtual interface terminates.
    id string
    The provider-assigned unique ID for this managed resource.
    jumboFrameCapable boolean
    Indicates whether jumbo frames (8500 MTU) are supported.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    amazon_side_asn str
    arn str
    The ARN of the virtual interface.
    aws_device str
    The Direct Connect endpoint on which the virtual interface terminates.
    id str
    The provider-assigned unique ID for this managed resource.
    jumbo_frame_capable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    amazonSideAsn String
    arn String
    The ARN of the virtual interface.
    awsDevice String
    The Direct Connect endpoint on which the virtual interface terminates.
    id String
    The provider-assigned unique ID for this managed resource.
    jumboFrameCapable Boolean
    Indicates whether jumbo frames (8500 MTU) are supported.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing TransitVirtualInterface Resource

    Get an existing TransitVirtualInterface resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TransitVirtualInterfaceState, opts?: CustomResourceOptions): TransitVirtualInterface
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        address_family: Optional[str] = None,
        amazon_address: Optional[str] = None,
        amazon_side_asn: Optional[str] = None,
        arn: Optional[str] = None,
        aws_device: Optional[str] = None,
        bgp_asn: Optional[int] = None,
        bgp_asn_long: Optional[str] = None,
        bgp_auth_key: Optional[str] = None,
        connection_id: Optional[str] = None,
        customer_address: Optional[str] = None,
        dx_gateway_id: Optional[str] = None,
        jumbo_frame_capable: Optional[bool] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        prefix_pool_allocated_count_ipv4: Optional[int] = None,
        prefix_pool_allocated_count_ipv6: Optional[int] = None,
        rate_limit: Optional[str] = None,
        region: Optional[str] = None,
        sitelink_enabled: Optional[bool] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vlan: Optional[int] = None) -> TransitVirtualInterface
    func GetTransitVirtualInterface(ctx *Context, name string, id IDInput, state *TransitVirtualInterfaceState, opts ...ResourceOption) (*TransitVirtualInterface, error)
    public static TransitVirtualInterface Get(string name, Input<string> id, TransitVirtualInterfaceState? state, CustomResourceOptions? opts = null)
    public static TransitVirtualInterface get(String name, Output<String> id, TransitVirtualInterfaceState state, CustomResourceOptions options)
    resources:  _:    type: aws:directconnect:TransitVirtualInterface    get:      id: ${id}
    import {
  to = aws_directconnect_transit_virtual_interface.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AddressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    AmazonAddress string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    AmazonSideAsn string
    Arn string
    The ARN of the virtual interface.
    AwsDevice string
    The Direct Connect endpoint on which the virtual interface terminates.
    BgpAsn int
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAsnLong string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAuthKey string
    The authentication key for BGP configuration.
    ConnectionId string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    CustomerAddress string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    DxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    JumboFrameCapable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    Mtu int
    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.
    Name string
    The name for the virtual interface.
    PrefixPoolAllocatedCountIpv4 int
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    PrefixPoolAllocatedCountIpv6 int
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    RateLimit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SitelinkEnabled bool
    Indicates whether to enable or disable SiteLink.
    Tags Dictionary<string, string>
    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Vlan int
    The VLAN ID.
    AddressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    AmazonAddress string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    AmazonSideAsn string
    Arn string
    The ARN of the virtual interface.
    AwsDevice string
    The Direct Connect endpoint on which the virtual interface terminates.
    BgpAsn int
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAsnLong string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    BgpAuthKey string
    The authentication key for BGP configuration.
    ConnectionId string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    CustomerAddress string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    DxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    JumboFrameCapable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    Mtu int
    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.
    Name string
    The name for the virtual interface.
    PrefixPoolAllocatedCountIpv4 int
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    PrefixPoolAllocatedCountIpv6 int
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    RateLimit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    SitelinkEnabled bool
    Indicates whether to enable or disable SiteLink.
    Tags map[string]string
    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    Vlan int
    The VLAN ID.
    address_family string
    The address family for the BGP peer. ipv4 or ipv6.
    amazon_address string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    amazon_side_asn string
    arn string
    The ARN of the virtual interface.
    aws_device string
    The Direct Connect endpoint on which the virtual interface terminates.
    bgp_asn number
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_asn_long string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_auth_key string
    The authentication key for BGP configuration.
    connection_id string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    customer_address string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    dx_gateway_id string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    jumbo_frame_capable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    mtu number
    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.
    name string
    The name for the virtual interface.
    prefix_pool_allocated_count_ipv4 number
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefix_pool_allocated_count_ipv6 number
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rate_limit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelink_enabled bool
    Indicates whether to enable or disable SiteLink.
    tags map(string)
    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.
    tags_all map(string)
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vlan number
    The VLAN ID.
    addressFamily String
    The address family for the BGP peer. ipv4 or ipv6.
    amazonAddress String
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    amazonSideAsn String
    arn String
    The ARN of the virtual interface.
    awsDevice String
    The Direct Connect endpoint on which the virtual interface terminates.
    bgpAsn Integer
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAsnLong String
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAuthKey String
    The authentication key for BGP configuration.
    connectionId String
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    customerAddress String
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    dxGatewayId String
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    jumboFrameCapable Boolean
    Indicates whether jumbo frames (8500 MTU) are supported.
    mtu Integer
    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.
    name String
    The name for the virtual interface.
    prefixPoolAllocatedCountIpv4 Integer
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefixPoolAllocatedCountIpv6 Integer
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rateLimit String
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelinkEnabled Boolean
    Indicates whether to enable or disable SiteLink.
    tags Map<String,String>
    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vlan Integer
    The VLAN ID.
    addressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    amazonAddress string
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    amazonSideAsn string
    arn string
    The ARN of the virtual interface.
    awsDevice string
    The Direct Connect endpoint on which the virtual interface terminates.
    bgpAsn number
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAsnLong string
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAuthKey string
    The authentication key for BGP configuration.
    connectionId string
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    customerAddress string
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    dxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    jumboFrameCapable boolean
    Indicates whether jumbo frames (8500 MTU) are supported.
    mtu number
    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.
    name string
    The name for the virtual interface.
    prefixPoolAllocatedCountIpv4 number
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefixPoolAllocatedCountIpv6 number
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rateLimit string
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelinkEnabled boolean
    Indicates whether to enable or disable SiteLink.
    tags {[key: string]: string}
    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vlan number
    The VLAN ID.
    address_family str
    The address family for the BGP peer. ipv4 or ipv6.
    amazon_address str
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    amazon_side_asn str
    arn str
    The ARN of the virtual interface.
    aws_device str
    The Direct Connect endpoint on which the virtual interface terminates.
    bgp_asn int
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_asn_long str
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgp_auth_key str
    The authentication key for BGP configuration.
    connection_id str
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    customer_address str
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    dx_gateway_id str
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    jumbo_frame_capable bool
    Indicates whether jumbo frames (8500 MTU) are supported.
    mtu int
    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.
    name str
    The name for the virtual interface.
    prefix_pool_allocated_count_ipv4 int
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefix_pool_allocated_count_ipv6 int
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rate_limit str
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelink_enabled bool
    Indicates whether to enable or disable SiteLink.
    tags Mapping[str, str]
    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vlan int
    The VLAN ID.
    addressFamily String
    The address family for the BGP peer. ipv4 or ipv6.
    amazonAddress String
    The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
    amazonSideAsn String
    arn String
    The ARN of the virtual interface.
    awsDevice String
    The Direct Connect endpoint on which the virtual interface terminates.
    bgpAsn Number
    BGP autonomous system number as an integer between 1 and 2147483646. For larger values, use bgpAsnLong. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAsnLong String
    BGP autonomous system number as an asplain decimal string between 1 and 4294967294. This argument also accepts values in the bgpAsn range. Exactly one of bgpAsn or bgpAsnLong must be specified.
    bgpAuthKey String
    The authentication key for BGP configuration.
    connectionId String
    The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
    customerAddress String
    The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
    dxGatewayId String
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    jumboFrameCapable Boolean
    Indicates whether jumbo frames (8500 MTU) are supported.
    mtu Number
    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.
    name String
    The name for the virtual interface.
    prefixPoolAllocatedCountIpv4 Number
    The number of inbound IPv4 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    prefixPoolAllocatedCountIpv6 Number
    The number of inbound IPv6 route prefixes to allocate to the virtual interface. Valid values are 0 to 1000. If not specified, AWS applies the default allocation of 100.
    rateLimit String
    Maximum bandwidth allocation for the virtual interface, restricting the bandwidth it can use on the parent connection. Specify a supported bandwidth value without a space (for example, 50Mbps, 1Gbps, or 10Gbps); the value cannot exceed the bandwidth of the parent connection or link aggregation group (LAG), and supported values range up to 1.6Tbps. See the VIF Rate Limiters documentation for the full list of supported values. Rate Limiters are supported only on Direct Connect dedicated connections (including LAGs); they are not supported on hosted connections.
    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    sitelinkEnabled Boolean
    Indicates whether to enable or disable SiteLink.
    tags Map<String>
    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    vlan Number
    The VLAN ID.

    Import

    Using pulumi import, import Direct Connect transit virtual interfaces using the VIF id. For example:

    $ pulumi import aws:directconnect/transitVirtualInterface:TransitVirtualInterface test dxvif-33cc44dd

    Note: When a virtual interface uses an ASN in the bgpAsn range (1 to 2147483646), AWS returns the value in both the asn and asnLong API fields, so import always populates bgpAsn rather than bgpAsnLong. If the virtual interface was originally created with bgpAsnLong set to a value in that range, update your configuration to use bgpAsn after import to avoid a difference. Virtual interfaces using a 4-byte ASN (greater than 2147483646) import into bgpAsnLong as expected.

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo aws logo
    Viewing docs for AWS v7.46.0
    published on Thursday, Sep 10, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial