TransitVirtualInterface class

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)
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 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
	})
}
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
}
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

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.

Constructors

TransitVirtualInterface(String name, {TransitVirtualInterfaceArgs? args, CustomResourceOptions? options})
Creates a new TransitVirtualInterface. name The Pulumi resource name. args Arguments used to configure this TransitVirtualInterface. The set of arguments for TransitVirtualInterface. options Resource options controlling this resource's behavior.
TransitVirtualInterface.reference(String urn)
Creates a typed reference to an existing TransitVirtualInterface resource.

Properties

addressFamily ↔ Output<String>
The address family for the BGP peer. ipv4 or ipv6.
latefinal
amazonAddress ↔ Output<String>
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
latefinal
amazonSideAsn ↔ Output<String>
latefinal
arn ↔ Output<String>
The ARN of the virtual interface.
latefinal
awsDevice ↔ Output<String>
The Direct Connect endpoint on which the virtual interface terminates.
latefinal
bgpAsn ↔ Output<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.
latefinal
bgpAsnLong ↔ Output<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.
latefinal
bgpAuthKey ↔ Output<String>
The authentication key for BGP configuration.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
connectionId ↔ Output<String>
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
latefinal
customerAddress ↔ Output<String>
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
latefinal
dxGatewayId ↔ Output<String>
The ID of the Direct Connect gateway to which to connect the virtual interface.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
jumboFrameCapable ↔ Output<bool>
Indicates whether jumbo frames (8500 MTU) are supported.
latefinal
mtu ↔ Output<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.
latefinal
name ↔ Output<String>
The name for the virtual interface.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sitelinkEnabled ↔ Output<bool?>
Indicates whether to enable or disable SiteLink.
latefinal
tags ↔ Output<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.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vlan ↔ Output<int>
The VLAN ID.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TransitVirtualInterfaceState? state, CustomResourceOptions? options}) → TransitVirtualInterface
Gets an existing TransitVirtualInterface resource's state with the given name and id.