AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.9.1 published on Tuesday, Jun 21, 2022 by Pulumi

HostedPrivateVirtualInterface

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

using Pulumi;
using Aws = Pulumi.Aws;

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

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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{
			AddressFamily: pulumi.String("ipv4"),
			BgpAsn:        pulumi.Int(65352),
			ConnectionId:  pulumi.String("dxcon-zzzzzzzz"),
			Vlan:          pulumi.Int(4094),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()        
            .addressFamily("ipv4")
            .bgpAsn(65352)
            .connectionId("dxcon-zzzzzzzz")
            .vlan(4094)
            .build());

    }
}
import pulumi
import pulumi_aws as aws

foo = aws.directconnect.HostedPrivateVirtualInterface("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.HostedPrivateVirtualInterface("foo", {
    addressFamily: "ipv4",
    bgpAsn: 65352,
    connectionId: "dxcon-zzzzzzzz",
    vlan: 4094,
});
resources:
  foo:
    type: aws:directconnect:HostedPrivateVirtualInterface
    properties:
      addressFamily: ipv4
      bgpAsn: 65352
      connectionId: dxcon-zzzzzzzz
      vlan: 4094

Create a HostedPrivateVirtualInterface Resource

new HostedPrivateVirtualInterface(name: string, args: HostedPrivateVirtualInterfaceArgs, opts?: CustomResourceOptions);
@overload
def HostedPrivateVirtualInterface(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  address_family: Optional[str] = None,
                                  amazon_address: Optional[str] = None,
                                  bgp_asn: Optional[int] = None,
                                  bgp_auth_key: Optional[str] = None,
                                  connection_id: Optional[str] = None,
                                  customer_address: Optional[str] = None,
                                  mtu: Optional[int] = None,
                                  name: Optional[str] = None,
                                  owner_account_id: Optional[str] = None,
                                  vlan: Optional[int] = None)
@overload
def HostedPrivateVirtualInterface(resource_name: str,
                                  args: HostedPrivateVirtualInterfaceArgs,
                                  opts: Optional[ResourceOptions] = 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.

name string
The unique name of the resource.
args HostedPrivateVirtualInterfaceArgs
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 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 string
The unique name of the resource.
args HostedPrivateVirtualInterfaceArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args HostedPrivateVirtualInterfaceArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args HostedPrivateVirtualInterfaceArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The HostedPrivateVirtualInterface 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.

OwnerAccountId string

The AWS account that will own the new 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.

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.

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.

OwnerAccountId string

The AWS account that will own the new 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.

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.

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.

ownerAccountId String

The AWS account that will own the new 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.

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.

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.

ownerAccountId string

The AWS account that will own the new 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.

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.

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.

owner_account_id str

The AWS account that will own the new 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.

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.

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.

ownerAccountId String

The AWS account that will own the new 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.

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.

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 an 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)
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.

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.

OwnerAccountId string

The AWS account that will own the new virtual interface.

Vlan int

The VLAN ID.

AddressFamily string

The address family for the BGP peer. ipv4 or ipv6.

AmazonAddress string

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

AmazonSideAsn string
Arn string

The ARN of the virtual interface.

AwsDevice string

The Direct Connect endpoint on which the virtual interface terminates.

BgpAsn int

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.

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.

OwnerAccountId string

The AWS account that will own the new virtual interface.

Vlan int

The VLAN ID.

addressFamily String

The address family for the BGP peer. ipv4 or ipv6.

amazonAddress String

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

amazonSideAsn String
arn String

The ARN of the virtual interface.

awsDevice String

The Direct Connect endpoint on which the virtual interface terminates.

bgpAsn 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.

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.

ownerAccountId String

The AWS account that will own the new virtual interface.

vlan Integer

The VLAN ID.

addressFamily string

The address family for the BGP peer. ipv4 or ipv6.

amazonAddress string

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

amazonSideAsn string
arn string

The ARN of the virtual interface.

awsDevice string

The Direct Connect endpoint on which the virtual interface terminates.

bgpAsn number

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.

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.

ownerAccountId string

The AWS account that will own the new virtual interface.

vlan number

The VLAN ID.

address_family str

The address family for the BGP peer. ipv4 or ipv6.

amazon_address str

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

amazon_side_asn str
arn str

The ARN of the virtual interface.

aws_device str

The Direct Connect endpoint on which the virtual interface terminates.

bgp_asn int

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.

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.

owner_account_id str

The AWS account that will own the new virtual interface.

vlan int

The VLAN ID.

addressFamily String

The address family for the BGP peer. ipv4 or ipv6.

amazonAddress String

The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.

amazonSideAsn String
arn String

The ARN of the virtual interface.

awsDevice String

The Direct Connect endpoint on which the virtual interface terminates.

bgpAsn Number

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.

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.

ownerAccountId String

The AWS account that will own the new virtual interface.

vlan Number

The VLAN ID.

Import

Direct Connect hosted private virtual interfaces can be imported using the vif id, e.g.,

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.