Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. directconnect
  5. HostedPrivateVirtualInterface
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.directconnect.HostedPrivateVirtualInterface

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides a Direct Connect hosted private virtual interface resource. This resource represents the allocator’s side of the hosted virtual interface. A hosted virtual interface is a virtual interface that is owned by another AWS account.

Example Usage

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

const foo = new aws.directconnect.HostedPrivateVirtualInterface("foo", {
    connectionId: "dxcon-zzzzzzzz",
    name: "vif-foo",
    vlan: 4094,
    addressFamily: "ipv4",
    bgpAsn: 65352,
});
Copy
import pulumi
import pulumi_aws as aws

foo = aws.directconnect.HostedPrivateVirtualInterface("foo",
    connection_id="dxcon-zzzzzzzz",
    name="vif-foo",
    vlan=4094,
    address_family="ipv4",
    bgp_asn=65352)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := directconnect.NewHostedPrivateVirtualInterface(ctx, "foo", &directconnect.HostedPrivateVirtualInterfaceArgs{
			ConnectionId:  pulumi.String("dxcon-zzzzzzzz"),
			Name:          pulumi.String("vif-foo"),
			Vlan:          pulumi.Int(4094),
			AddressFamily: pulumi.String("ipv4"),
			BgpAsn:        pulumi.Int(65352),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var foo = new Aws.DirectConnect.HostedPrivateVirtualInterface("foo", new()
    {
        ConnectionId = "dxcon-zzzzzzzz",
        Name = "vif-foo",
        Vlan = 4094,
        AddressFamily = "ipv4",
        BgpAsn = 65352,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.HostedPrivateVirtualInterface;
import com.pulumi.aws.directconnect.HostedPrivateVirtualInterfaceArgs;
import java.util.List;
import java.util.ArrayList;
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 foo = new HostedPrivateVirtualInterface("foo", HostedPrivateVirtualInterfaceArgs.builder()
            .connectionId("dxcon-zzzzzzzz")
            .name("vif-foo")
            .vlan(4094)
            .addressFamily("ipv4")
            .bgpAsn(65352)
            .build());

    }
}
Copy
resources:
  foo:
    type: aws:directconnect:HostedPrivateVirtualInterface
    properties:
      connectionId: dxcon-zzzzzzzz
      name: vif-foo
      vlan: 4094
      addressFamily: ipv4
      bgpAsn: 65352
Copy

Create HostedPrivateVirtualInterface Resource

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

Constructor syntax

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

@overload
def HostedPrivateVirtualInterface(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  address_family: Optional[str] = None,
                                  bgp_asn: Optional[int] = None,
                                  connection_id: Optional[str] = None,
                                  owner_account_id: Optional[str] = None,
                                  vlan: Optional[int] = None,
                                  amazon_address: Optional[str] = None,
                                  bgp_auth_key: Optional[str] = None,
                                  customer_address: Optional[str] = None,
                                  mtu: Optional[int] = None,
                                  name: Optional[str] = None)
func NewHostedPrivateVirtualInterface(ctx *Context, name string, args HostedPrivateVirtualInterfaceArgs, opts ...ResourceOption) (*HostedPrivateVirtualInterface, error)
public HostedPrivateVirtualInterface(string name, HostedPrivateVirtualInterfaceArgs args, CustomResourceOptions? opts = null)
public HostedPrivateVirtualInterface(String name, HostedPrivateVirtualInterfaceArgs args)
public HostedPrivateVirtualInterface(String name, HostedPrivateVirtualInterfaceArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HostedPrivateVirtualInterfaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HostedPrivateVirtualInterfaceArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HostedPrivateVirtualInterfaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HostedPrivateVirtualInterfaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HostedPrivateVirtualInterfaceArgs
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 hostedPrivateVirtualInterfaceResource = new Aws.DirectConnect.HostedPrivateVirtualInterface("hostedPrivateVirtualInterfaceResource", new()
{
    AddressFamily = "string",
    BgpAsn = 0,
    ConnectionId = "string",
    OwnerAccountId = "string",
    Vlan = 0,
    AmazonAddress = "string",
    BgpAuthKey = "string",
    CustomerAddress = "string",
    Mtu = 0,
    Name = "string",
});
Copy
example, err := directconnect.NewHostedPrivateVirtualInterface(ctx, "hostedPrivateVirtualInterfaceResource", &directconnect.HostedPrivateVirtualInterfaceArgs{
	AddressFamily:   pulumi.String("string"),
	BgpAsn:          pulumi.Int(0),
	ConnectionId:    pulumi.String("string"),
	OwnerAccountId:  pulumi.String("string"),
	Vlan:            pulumi.Int(0),
	AmazonAddress:   pulumi.String("string"),
	BgpAuthKey:      pulumi.String("string"),
	CustomerAddress: pulumi.String("string"),
	Mtu:             pulumi.Int(0),
	Name:            pulumi.String("string"),
})
Copy
var hostedPrivateVirtualInterfaceResource = new HostedPrivateVirtualInterface("hostedPrivateVirtualInterfaceResource", HostedPrivateVirtualInterfaceArgs.builder()
    .addressFamily("string")
    .bgpAsn(0)
    .connectionId("string")
    .ownerAccountId("string")
    .vlan(0)
    .amazonAddress("string")
    .bgpAuthKey("string")
    .customerAddress("string")
    .mtu(0)
    .name("string")
    .build());
Copy
hosted_private_virtual_interface_resource = aws.directconnect.HostedPrivateVirtualInterface("hostedPrivateVirtualInterfaceResource",
    address_family="string",
    bgp_asn=0,
    connection_id="string",
    owner_account_id="string",
    vlan=0,
    amazon_address="string",
    bgp_auth_key="string",
    customer_address="string",
    mtu=0,
    name="string")
Copy
const hostedPrivateVirtualInterfaceResource = new aws.directconnect.HostedPrivateVirtualInterface("hostedPrivateVirtualInterfaceResource", {
    addressFamily: "string",
    bgpAsn: 0,
    connectionId: "string",
    ownerAccountId: "string",
    vlan: 0,
    amazonAddress: "string",
    bgpAuthKey: "string",
    customerAddress: "string",
    mtu: 0,
    name: "string",
});
Copy
type: aws:directconnect:HostedPrivateVirtualInterface
properties:
    addressFamily: string
    amazonAddress: string
    bgpAsn: 0
    bgpAuthKey: string
    connectionId: string
    customerAddress: string
    mtu: 0
    name: string
    ownerAccountId: string
    vlan: 0
Copy

HostedPrivateVirtualInterface 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 HostedPrivateVirtualInterface resource accepts the following input properties:

AddressFamily
This property is required.
Changes to this property will trigger replacement.
string
The address family for the BGP peer. ipv4 or ipv6.
BgpAsn
This property is required.
Changes to this property will trigger replacement.
int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
ConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
OwnerAccountId
This property is required.
Changes to this property will trigger replacement.
string
The AWS account that will own the new virtual interface.
Vlan
This property is required.
Changes to this property will trigger replacement.
int
The VLAN ID.
AmazonAddress Changes to this property will trigger replacement. string
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
BgpAuthKey Changes to this property will trigger replacement. string
The authentication key for BGP configuration.
CustomerAddress Changes to this property will trigger replacement. string
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
Mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
Name Changes to this property will trigger replacement. string
The name for the virtual interface.
AddressFamily
This property is required.
Changes to this property will trigger replacement.
string
The address family for the BGP peer. ipv4 or ipv6.
BgpAsn
This property is required.
Changes to this property will trigger replacement.
int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
ConnectionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
OwnerAccountId
This property is required.
Changes to this property will trigger replacement.
string
The AWS account that will own the new virtual interface.
Vlan
This property is required.
Changes to this property will trigger replacement.
int
The VLAN ID.
AmazonAddress Changes to this property will trigger replacement. string
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
BgpAuthKey Changes to this property will trigger replacement. string
The authentication key for BGP configuration.
CustomerAddress Changes to this property will trigger replacement. string
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
Mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
Name Changes to this property will trigger replacement. string
The name for the virtual interface.
addressFamily
This property is required.
Changes to this property will trigger replacement.
String
The address family for the BGP peer. ipv4 or ipv6.
bgpAsn
This property is required.
Changes to this property will trigger replacement.
Integer
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
connectionId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
ownerAccountId
This property is required.
Changes to this property will trigger replacement.
String
The AWS account that will own the new virtual interface.
vlan
This property is required.
Changes to this property will trigger replacement.
Integer
The VLAN ID.
amazonAddress Changes to this property will trigger replacement. String
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgpAuthKey Changes to this property will trigger replacement. String
The authentication key for BGP configuration.
customerAddress Changes to this property will trigger replacement. String
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. String
The name for the virtual interface.
addressFamily
This property is required.
Changes to this property will trigger replacement.
string
The address family for the BGP peer. ipv4 or ipv6.
bgpAsn
This property is required.
Changes to this property will trigger replacement.
number
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
connectionId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
ownerAccountId
This property is required.
Changes to this property will trigger replacement.
string
The AWS account that will own the new virtual interface.
vlan
This property is required.
Changes to this property will trigger replacement.
number
The VLAN ID.
amazonAddress Changes to this property will trigger replacement. string
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgpAuthKey Changes to this property will trigger replacement. string
The authentication key for BGP configuration.
customerAddress Changes to this property will trigger replacement. string
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. string
The name for the virtual interface.
address_family
This property is required.
Changes to this property will trigger replacement.
str
The address family for the BGP peer. ipv4 or ipv6.
bgp_asn
This property is required.
Changes to this property will trigger replacement.
int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
connection_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
owner_account_id
This property is required.
Changes to this property will trigger replacement.
str
The AWS account that will own the new virtual interface.
vlan
This property is required.
Changes to this property will trigger replacement.
int
The VLAN ID.
amazon_address Changes to this property will trigger replacement. str
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgp_auth_key Changes to this property will trigger replacement. str
The authentication key for BGP configuration.
customer_address Changes to this property will trigger replacement. str
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. str
The name for the virtual interface.
addressFamily
This property is required.
Changes to this property will trigger replacement.
String
The address family for the BGP peer. ipv4 or ipv6.
bgpAsn
This property is required.
Changes to this property will trigger replacement.
Number
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
connectionId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
ownerAccountId
This property is required.
Changes to this property will trigger replacement.
String
The AWS account that will own the new virtual interface.
vlan
This property is required.
Changes to this property will trigger replacement.
Number
The VLAN ID.
amazonAddress Changes to this property will trigger replacement. String
The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
bgpAuthKey Changes to this property will trigger replacement. String
The authentication key for BGP configuration.
customerAddress Changes to this property will trigger replacement. String
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. String
The name for the virtual interface.

Outputs

All input properties are implicitly available as output properties. Additionally, the HostedPrivateVirtualInterface 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 (9001 MTU) are supported.
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 (9001 MTU) are supported.
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 (9001 MTU) are supported.
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 (9001 MTU) are supported.
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 (9001 MTU) are supported.
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 (9001 MTU) are supported.

Look up Existing HostedPrivateVirtualInterface Resource

Get an existing HostedPrivateVirtualInterface 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?: HostedPrivateVirtualInterfaceState, opts?: CustomResourceOptions): HostedPrivateVirtualInterface
@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_auth_key: Optional[str] = None,
        connection_id: Optional[str] = None,
        customer_address: Optional[str] = None,
        jumbo_frame_capable: Optional[bool] = None,
        mtu: Optional[int] = None,
        name: Optional[str] = None,
        owner_account_id: Optional[str] = None,
        vlan: Optional[int] = None) -> HostedPrivateVirtualInterface
func GetHostedPrivateVirtualInterface(ctx *Context, name string, id IDInput, state *HostedPrivateVirtualInterfaceState, opts ...ResourceOption) (*HostedPrivateVirtualInterface, error)
public static HostedPrivateVirtualInterface Get(string name, Input<string> id, HostedPrivateVirtualInterfaceState? state, CustomResourceOptions? opts = null)
public static HostedPrivateVirtualInterface get(String name, Output<String> id, HostedPrivateVirtualInterfaceState state, CustomResourceOptions options)
resources:  _:    type: aws:directconnect:HostedPrivateVirtualInterface    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 Changes to this property will trigger replacement. string
The address family for the BGP peer. ipv4 or ipv6.
AmazonAddress Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
BgpAuthKey Changes to this property will trigger replacement. string
The authentication key for BGP configuration.
ConnectionId Changes to this property will trigger replacement. string
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
CustomerAddress Changes to this property will trigger replacement. string
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
JumboFrameCapable bool
Indicates whether jumbo frames (9001 MTU) are supported.
Mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
Name Changes to this property will trigger replacement. string
The name for the virtual interface.
OwnerAccountId Changes to this property will trigger replacement. string
The AWS account that will own the new virtual interface.
Vlan Changes to this property will trigger replacement. int
The VLAN ID.
AddressFamily Changes to this property will trigger replacement. string
The address family for the BGP peer. ipv4 or ipv6.
AmazonAddress Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
BgpAuthKey Changes to this property will trigger replacement. string
The authentication key for BGP configuration.
ConnectionId Changes to this property will trigger replacement. string
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
CustomerAddress Changes to this property will trigger replacement. string
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
JumboFrameCapable bool
Indicates whether jumbo frames (9001 MTU) are supported.
Mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
Name Changes to this property will trigger replacement. string
The name for the virtual interface.
OwnerAccountId Changes to this property will trigger replacement. string
The AWS account that will own the new virtual interface.
Vlan Changes to this property will trigger replacement. int
The VLAN ID.
addressFamily Changes to this property will trigger replacement. String
The address family for the BGP peer. ipv4 or ipv6.
amazonAddress Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Integer
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgpAuthKey Changes to this property will trigger replacement. String
The authentication key for BGP configuration.
connectionId Changes to this property will trigger replacement. String
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customerAddress Changes to this property will trigger replacement. String
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
jumboFrameCapable Boolean
Indicates whether jumbo frames (9001 MTU) are supported.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. String
The name for the virtual interface.
ownerAccountId Changes to this property will trigger replacement. String
The AWS account that will own the new virtual interface.
vlan Changes to this property will trigger replacement. Integer
The VLAN ID.
addressFamily Changes to this property will trigger replacement. string
The address family for the BGP peer. ipv4 or ipv6.
amazonAddress Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. number
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgpAuthKey Changes to this property will trigger replacement. string
The authentication key for BGP configuration.
connectionId Changes to this property will trigger replacement. string
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customerAddress Changes to this property will trigger replacement. string
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
jumboFrameCapable boolean
Indicates whether jumbo frames (9001 MTU) are supported.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. string
The name for the virtual interface.
ownerAccountId Changes to this property will trigger replacement. string
The AWS account that will own the new virtual interface.
vlan Changes to this property will trigger replacement. number
The VLAN ID.
address_family Changes to this property will trigger replacement. str
The address family for the BGP peer. ipv4 or ipv6.
amazon_address Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. int
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgp_auth_key Changes to this property will trigger replacement. str
The authentication key for BGP configuration.
connection_id Changes to this property will trigger replacement. str
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customer_address Changes to this property will trigger replacement. str
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
jumbo_frame_capable bool
Indicates whether jumbo frames (9001 MTU) are supported.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. str
The name for the virtual interface.
owner_account_id Changes to this property will trigger replacement. str
The AWS account that will own the new virtual interface.
vlan Changes to this property will trigger replacement. int
The VLAN ID.
addressFamily Changes to this property will trigger replacement. String
The address family for the BGP peer. ipv4 or ipv6.
amazonAddress Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. Number
The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
bgpAuthKey Changes to this property will trigger replacement. String
The authentication key for BGP configuration.
connectionId Changes to this property will trigger replacement. String
The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
customerAddress Changes to this property will trigger replacement. String
The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
jumboFrameCapable Boolean
Indicates whether jumbo frames (9001 MTU) are supported.
mtu Changes to this property will trigger replacement. 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
name Changes to this property will trigger replacement. String
The name for the virtual interface.
ownerAccountId Changes to this property will trigger replacement. String
The AWS account that will own the new virtual interface.
vlan Changes to this property will trigger replacement. Number
The VLAN ID.

Import

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

$ pulumi import aws:directconnect/hostedPrivateVirtualInterface:HostedPrivateVirtualInterface test dxvif-33cc44dd
Copy

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 v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws