Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. directconnect
  5. PrivateVirtualInterface

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

aws.directconnect.PrivateVirtualInterface

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws

    Provides a Direct Connect private virtual interface resource.

    Example Usage

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

const foo = new aws.directconnect.PrivateVirtualInterface("foo", {
    connectionId: "dxcon-zzzzzzzz",
    name: "vif-foo",
    vlan: 4094,
    addressFamily: "ipv4",
    bgpAsn: 65352,
});

    import pulumi
import pulumi_aws as aws

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

    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.NewPrivateVirtualInterface(ctx, "foo", &directconnect.PrivateVirtualInterfaceArgs{
			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
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Aws.DirectConnect.PrivateVirtualInterface("foo", new()
    {
        ConnectionId = "dxcon-zzzzzzzz",
        Name = "vif-foo",
        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.PrivateVirtualInterface;
import com.pulumi.aws.directconnect.PrivateVirtualInterfaceArgs;
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 PrivateVirtualInterface("foo", PrivateVirtualInterfaceArgs.builder()
            .connectionId("dxcon-zzzzzzzz")
            .name("vif-foo")
            .vlan(4094)
            .addressFamily("ipv4")
            .bgpAsn(65352)
            .build());

    }
}

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

    Create PrivateVirtualInterface Resource

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

    Constructor syntax

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

@overload
def PrivateVirtualInterface(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            connection_id: Optional[str] = None,
                            vlan: Optional[int] = None,
                            bgp_asn: Optional[int] = None,
                            address_family: Optional[str] = None,
                            dx_gateway_id: Optional[str] = None,
                            customer_address: Optional[str] = None,
                            bgp_auth_key: Optional[str] = None,
                            mtu: Optional[int] = None,
                            name: Optional[str] = None,
                            sitelink_enabled: Optional[bool] = None,
                            tags: Optional[Mapping[str, str]] = None,
                            amazon_address: Optional[str] = None,
                            vpn_gateway_id: Optional[str] = None)
    func NewPrivateVirtualInterface(ctx *Context, name string, args PrivateVirtualInterfaceArgs, opts ...ResourceOption) (*PrivateVirtualInterface, error)
    public PrivateVirtualInterface(string name, PrivateVirtualInterfaceArgs args, CustomResourceOptions? opts = null)
    public PrivateVirtualInterface(String name, PrivateVirtualInterfaceArgs args)
public PrivateVirtualInterface(String name, PrivateVirtualInterfaceArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args PrivateVirtualInterfaceArgs
    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 PrivateVirtualInterfaceArgs
    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 PrivateVirtualInterfaceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PrivateVirtualInterfaceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PrivateVirtualInterfaceArgs
    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 privateVirtualInterfaceResource = new Aws.DirectConnect.PrivateVirtualInterface("privateVirtualInterfaceResource", new()
{
    ConnectionId = "string",
    Vlan = 0,
    BgpAsn = 0,
    AddressFamily = "string",
    DxGatewayId = "string",
    CustomerAddress = "string",
    BgpAuthKey = "string",
    Mtu = 0,
    Name = "string",
    SitelinkEnabled = false,
    Tags = 
    {
        { "string", "string" },
    },
    AmazonAddress = "string",
    VpnGatewayId = "string",
});

    example, err := directconnect.NewPrivateVirtualInterface(ctx, "privateVirtualInterfaceResource", &directconnect.PrivateVirtualInterfaceArgs{
	ConnectionId:    pulumi.String("string"),
	Vlan:            pulumi.Int(0),
	BgpAsn:          pulumi.Int(0),
	AddressFamily:   pulumi.String("string"),
	DxGatewayId:     pulumi.String("string"),
	CustomerAddress: pulumi.String("string"),
	BgpAuthKey:      pulumi.String("string"),
	Mtu:             pulumi.Int(0),
	Name:            pulumi.String("string"),
	SitelinkEnabled: pulumi.Bool(false),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	AmazonAddress: pulumi.String("string"),
	VpnGatewayId:  pulumi.String("string"),
})

    var privateVirtualInterfaceResource = new PrivateVirtualInterface("privateVirtualInterfaceResource", PrivateVirtualInterfaceArgs.builder()
    .connectionId("string")
    .vlan(0)
    .bgpAsn(0)
    .addressFamily("string")
    .dxGatewayId("string")
    .customerAddress("string")
    .bgpAuthKey("string")
    .mtu(0)
    .name("string")
    .sitelinkEnabled(false)
    .tags(Map.of("string", "string"))
    .amazonAddress("string")
    .vpnGatewayId("string")
    .build());

    private_virtual_interface_resource = aws.directconnect.PrivateVirtualInterface("privateVirtualInterfaceResource",
    connection_id="string",
    vlan=0,
    bgp_asn=0,
    address_family="string",
    dx_gateway_id="string",
    customer_address="string",
    bgp_auth_key="string",
    mtu=0,
    name="string",
    sitelink_enabled=False,
    tags={
        "string": "string",
    },
    amazon_address="string",
    vpn_gateway_id="string")

    const privateVirtualInterfaceResource = new aws.directconnect.PrivateVirtualInterface("privateVirtualInterfaceResource", {
    connectionId: "string",
    vlan: 0,
    bgpAsn: 0,
    addressFamily: "string",
    dxGatewayId: "string",
    customerAddress: "string",
    bgpAuthKey: "string",
    mtu: 0,
    name: "string",
    sitelinkEnabled: false,
    tags: {
        string: "string",
    },
    amazonAddress: "string",
    vpnGatewayId: "string",
});

    type: aws:directconnect:PrivateVirtualInterface
properties:
    addressFamily: string
    amazonAddress: string
    bgpAsn: 0
    bgpAuthKey: string
    connectionId: string
    customerAddress: string
    dxGatewayId: string
    mtu: 0
    name: string
    sitelinkEnabled: false
    tags:
        string: string
    vlan: 0
    vpnGatewayId: string

    PrivateVirtualInterface Resource Properties

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

    Inputs

    The PrivateVirtualInterface resource accepts the following input properties:

    AddressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    BgpAsn int
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    ConnectionId string
    The ID of the Direct Connect connection (or LAG) on which to create 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.
    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.
    DxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    Name string
    The name for the virtual interface.
    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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VpnGatewayId string
    The ID of the virtual private gateway to which to connect the virtual interface.
    AddressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    BgpAsn int
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    ConnectionId string
    The ID of the Direct Connect connection (or LAG) on which to create 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.
    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.
    DxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    Name string
    The name for the virtual interface.
    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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    VpnGatewayId string
    The ID of the virtual private gateway to which to connect the virtual interface.
    addressFamily String
    The address family for the BGP peer. ipv4 or ipv6.
    bgpAsn Integer
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    connectionId String
    The ID of the Direct Connect connection (or LAG) on which to create 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.
    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.
    dxGatewayId String
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name String
    The name for the virtual interface.
    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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpnGatewayId String
    The ID of the virtual private gateway to which to connect the virtual interface.
    addressFamily string
    The address family for the BGP peer. ipv4 or ipv6.
    bgpAsn number
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    connectionId string
    The ID of the Direct Connect connection (or LAG) on which to create 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.
    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.
    dxGatewayId string
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name string
    The name for the virtual interface.
    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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpnGatewayId string
    The ID of the virtual private gateway to which to connect the virtual interface.
    address_family str
    The address family for the BGP peer. ipv4 or ipv6.
    bgp_asn int
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    connection_id str
    The ID of the Direct Connect connection (or LAG) on which to create 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_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.
    dx_gateway_id str
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name str
    The name for the virtual interface.
    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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpn_gateway_id str
    The ID of the virtual private gateway to which to connect the virtual interface.
    addressFamily String
    The address family for the BGP peer. ipv4 or ipv6.
    bgpAsn Number
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    connectionId String
    The ID of the Direct Connect connection (or LAG) on which to create 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.
    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.
    dxGatewayId String
    The ID of the Direct Connect gateway to which to connect the virtual interface.
    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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name String
    The name for the virtual interface.
    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 default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    vpnGatewayId String
    The ID of the virtual private gateway to which to connect the virtual interface.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateVirtualInterface 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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing PrivateVirtualInterface Resource

    Get an existing PrivateVirtualInterface 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?: PrivateVirtualInterfaceState, opts?: CustomResourceOptions): PrivateVirtualInterface
    @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,
        dx_gateway_id: Optional[str] = None,
        jumbo_frame_capable: Optional[bool] = None,
        mtu: Optional[int] = None,
        name: 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,
        vpn_gateway_id: Optional[str] = None) -> PrivateVirtualInterface
    func GetPrivateVirtualInterface(ctx *Context, name string, id IDInput, state *PrivateVirtualInterfaceState, opts ...ResourceOption) (*PrivateVirtualInterface, error)
    public static PrivateVirtualInterface Get(string name, Input<string> id, PrivateVirtualInterfaceState? state, CustomResourceOptions? opts = null)
    public static PrivateVirtualInterface get(String name, Output<String> id, PrivateVirtualInterfaceState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    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 (9001 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    Name string
    The name for the virtual interface.
    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 default_tags 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 default_tags configuration block.

    Deprecated: Please use tags instead.

    Vlan int
    The VLAN ID.
    VpnGatewayId string
    The ID of the virtual private gateway to which to connect the virtual interface.
    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
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    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 (9001 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    Name string
    The name for the virtual interface.
    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 default_tags 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 default_tags configuration block.

    Deprecated: Please use tags instead.

    Vlan int
    The VLAN ID.
    VpnGatewayId string
    The ID of the virtual private gateway to which to connect the virtual interface.
    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
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    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 (9001 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name String
    The name for the virtual interface.
    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 default_tags 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 default_tags configuration block.

    Deprecated: Please use tags instead.

    vlan Integer
    The VLAN ID.
    vpnGatewayId String
    The ID of the virtual private gateway to which to connect the virtual interface.
    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
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    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 (9001 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name string
    The name for the virtual interface.
    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 default_tags 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 default_tags configuration block.

    Deprecated: Please use tags instead.

    vlan number
    The VLAN ID.
    vpnGatewayId string
    The ID of the virtual private gateway to which to connect the virtual interface.
    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
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    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 (9001 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name str
    The name for the virtual interface.
    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 default_tags 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 default_tags configuration block.

    Deprecated: Please use tags instead.

    vlan int
    The VLAN ID.
    vpn_gateway_id str
    The ID of the virtual private gateway to which to connect the virtual interface.
    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
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    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 (9001 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 private interface can be either 1500 or 9001 (jumbo frames). Default is 1500.
    name String
    The name for the virtual interface.
    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 default_tags 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 default_tags configuration block.

    Deprecated: Please use tags instead.

    vlan Number
    The VLAN ID.
    vpnGatewayId String
    The ID of the virtual private gateway to which to connect the virtual interface.

    Import

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

    $ pulumi import aws:directconnect/privateVirtualInterface:PrivateVirtualInterface test dxvif-33cc44dd

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws