PrivateVirtualInterface

Provides a Direct Connect private virtual interface resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var foo = new Aws.DirectConnect.PrivateVirtualInterface("foo", new Aws.DirectConnect.PrivateVirtualInterfaceArgs
        {
            AddressFamily = "ipv4",
            BgpAsn = 65352,
            ConnectionId = "dxcon-zzzzzzzz",
            Vlan = 4094,
        });
    }

}

package main

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

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := directconnect.NewPrivateVirtualInterface(ctx, "foo", &directconnect.PrivateVirtualInterfaceArgs{
            AddressFamily: pulumi.String("ipv4"),
            BgpAsn:        pulumi.Int(65352),
            ConnectionId:  pulumi.String("dxcon-zzzzzzzz"),
            Vlan:          pulumi.Int(4094),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

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

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

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

Create a PrivateVirtualInterface Resource

new PrivateVirtualInterface(name: string, args: PrivateVirtualInterfaceArgs, opts?: CustomResourceOptions);

def PrivateVirtualInterface(resource_name, opts=None, address_family=None, amazon_address=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, dx_gateway_id=None, mtu=None, name=None, tags=None, vlan=None, vpn_gateway_id=None, __props__=None);

func NewPrivateVirtualInterface(ctx *Context, name string, args PrivateVirtualInterfaceArgs, opts ...ResourceOption) (*PrivateVirtualInterface, error)

public PrivateVirtualInterface(string name, PrivateVirtualInterfaceArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

PrivateVirtualInterface Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model 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.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
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.
Tags map[string]string: A map of tags to assign to the resource.
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.
tags {[key: string]: string}: A map of tags to assign to the resource.
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 float: 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 float: 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 float: 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.
tags Dict[str, str]: A map of tags to assign to the resource.
vpn_gateway_id str: 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.

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.

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.

Look up an 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

static get(resource_name, id, opts=None, address_family=None, amazon_address=None, amazon_side_asn=None, arn=None, aws_device=None, bgp_asn=None, bgp_auth_key=None, connection_id=None, customer_address=None, dx_gateway_id=None, jumbo_frame_capable=None, mtu=None, name=None, tags=None, vlan=None, vpn_gateway_id=None, __props__=None);

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)

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.

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.
Tags Dictionary<string, string>: A map of tags to assign to the resource.
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.
Tags map[string]string: A map of tags to assign to the resource.
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 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.
tags {[key: string]: string}: A map of tags to assign to the resource.
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 float: 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 float: 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.
tags Dict[str, str]: A map of tags to assign to the resource.
vlan float: The VLAN ID.
vpn_gateway_id str: The ID of the virtual private gateway to which to connect the virtual interface.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud