aws.directconnect.HostedPublicVirtualInterface
Explore with Pulumi AI
Provides a Direct Connect hosted public 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.HostedPublicVirtualInterface("foo", {
connectionId: "dxcon-zzzzzzzz",
name: "vif-foo",
vlan: 4094,
addressFamily: "ipv4",
bgpAsn: 65352,
customerAddress: "175.45.176.1/30",
amazonAddress: "175.45.176.2/30",
routeFilterPrefixes: [
"210.52.109.0/24",
"175.45.176.0/22",
],
});
import pulumi
import pulumi_aws as aws
foo = aws.directconnect.HostedPublicVirtualInterface("foo",
connection_id="dxcon-zzzzzzzz",
name="vif-foo",
vlan=4094,
address_family="ipv4",
bgp_asn=65352,
customer_address="175.45.176.1/30",
amazon_address="175.45.176.2/30",
route_filter_prefixes=[
"210.52.109.0/24",
"175.45.176.0/22",
])
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.NewHostedPublicVirtualInterface(ctx, "foo", &directconnect.HostedPublicVirtualInterfaceArgs{
ConnectionId: pulumi.String("dxcon-zzzzzzzz"),
Name: pulumi.String("vif-foo"),
Vlan: pulumi.Int(4094),
AddressFamily: pulumi.String("ipv4"),
BgpAsn: pulumi.Int(65352),
CustomerAddress: pulumi.String("175.45.176.1/30"),
AmazonAddress: pulumi.String("175.45.176.2/30"),
RouteFilterPrefixes: pulumi.StringArray{
pulumi.String("210.52.109.0/24"),
pulumi.String("175.45.176.0/22"),
},
})
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.HostedPublicVirtualInterface("foo", new()
{
ConnectionId = "dxcon-zzzzzzzz",
Name = "vif-foo",
Vlan = 4094,
AddressFamily = "ipv4",
BgpAsn = 65352,
CustomerAddress = "175.45.176.1/30",
AmazonAddress = "175.45.176.2/30",
RouteFilterPrefixes = new[]
{
"210.52.109.0/24",
"175.45.176.0/22",
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directconnect.HostedPublicVirtualInterface;
import com.pulumi.aws.directconnect.HostedPublicVirtualInterfaceArgs;
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 HostedPublicVirtualInterface("foo", HostedPublicVirtualInterfaceArgs.builder()
.connectionId("dxcon-zzzzzzzz")
.name("vif-foo")
.vlan(4094)
.addressFamily("ipv4")
.bgpAsn(65352)
.customerAddress("175.45.176.1/30")
.amazonAddress("175.45.176.2/30")
.routeFilterPrefixes(
"210.52.109.0/24",
"175.45.176.0/22")
.build());
}
}
resources:
foo:
type: aws:directconnect:HostedPublicVirtualInterface
properties:
connectionId: dxcon-zzzzzzzz
name: vif-foo
vlan: 4094
addressFamily: ipv4
bgpAsn: 65352
customerAddress: 175.45.176.1/30
amazonAddress: 175.45.176.2/30
routeFilterPrefixes:
- 210.52.109.0/24
- 175.45.176.0/22
Create HostedPublicVirtualInterface Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HostedPublicVirtualInterface(name: string, args: HostedPublicVirtualInterfaceArgs, opts?: CustomResourceOptions);
@overload
def HostedPublicVirtualInterface(resource_name: str,
args: HostedPublicVirtualInterfaceArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HostedPublicVirtualInterface(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,
route_filter_prefixes: Optional[Sequence[str]] = None,
vlan: Optional[int] = None,
amazon_address: Optional[str] = None,
bgp_auth_key: Optional[str] = None,
customer_address: Optional[str] = None,
name: Optional[str] = None)
func NewHostedPublicVirtualInterface(ctx *Context, name string, args HostedPublicVirtualInterfaceArgs, opts ...ResourceOption) (*HostedPublicVirtualInterface, error)
public HostedPublicVirtualInterface(string name, HostedPublicVirtualInterfaceArgs args, CustomResourceOptions? opts = null)
public HostedPublicVirtualInterface(String name, HostedPublicVirtualInterfaceArgs args)
public HostedPublicVirtualInterface(String name, HostedPublicVirtualInterfaceArgs args, CustomResourceOptions options)
type: aws:directconnect:HostedPublicVirtualInterface
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 HostedPublicVirtualInterfaceArgs
- 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 HostedPublicVirtualInterfaceArgs
- 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 HostedPublicVirtualInterfaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HostedPublicVirtualInterfaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HostedPublicVirtualInterfaceArgs
- 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 hostedPublicVirtualInterfaceResource = new Aws.DirectConnect.HostedPublicVirtualInterface("hostedPublicVirtualInterfaceResource", new()
{
AddressFamily = "string",
BgpAsn = 0,
ConnectionId = "string",
OwnerAccountId = "string",
RouteFilterPrefixes = new[]
{
"string",
},
Vlan = 0,
AmazonAddress = "string",
BgpAuthKey = "string",
CustomerAddress = "string",
Name = "string",
});
example, err := directconnect.NewHostedPublicVirtualInterface(ctx, "hostedPublicVirtualInterfaceResource", &directconnect.HostedPublicVirtualInterfaceArgs{
AddressFamily: pulumi.String("string"),
BgpAsn: pulumi.Int(0),
ConnectionId: pulumi.String("string"),
OwnerAccountId: pulumi.String("string"),
RouteFilterPrefixes: pulumi.StringArray{
pulumi.String("string"),
},
Vlan: pulumi.Int(0),
AmazonAddress: pulumi.String("string"),
BgpAuthKey: pulumi.String("string"),
CustomerAddress: pulumi.String("string"),
Name: pulumi.String("string"),
})
var hostedPublicVirtualInterfaceResource = new HostedPublicVirtualInterface("hostedPublicVirtualInterfaceResource", HostedPublicVirtualInterfaceArgs.builder()
.addressFamily("string")
.bgpAsn(0)
.connectionId("string")
.ownerAccountId("string")
.routeFilterPrefixes("string")
.vlan(0)
.amazonAddress("string")
.bgpAuthKey("string")
.customerAddress("string")
.name("string")
.build());
hosted_public_virtual_interface_resource = aws.directconnect.HostedPublicVirtualInterface("hostedPublicVirtualInterfaceResource",
address_family="string",
bgp_asn=0,
connection_id="string",
owner_account_id="string",
route_filter_prefixes=["string"],
vlan=0,
amazon_address="string",
bgp_auth_key="string",
customer_address="string",
name="string")
const hostedPublicVirtualInterfaceResource = new aws.directconnect.HostedPublicVirtualInterface("hostedPublicVirtualInterfaceResource", {
addressFamily: "string",
bgpAsn: 0,
connectionId: "string",
ownerAccountId: "string",
routeFilterPrefixes: ["string"],
vlan: 0,
amazonAddress: "string",
bgpAuthKey: "string",
customerAddress: "string",
name: "string",
});
type: aws:directconnect:HostedPublicVirtualInterface
properties:
addressFamily: string
amazonAddress: string
bgpAsn: 0
bgpAuthKey: string
connectionId: string
customerAddress: string
name: string
ownerAccountId: string
routeFilterPrefixes:
- string
vlan: 0
HostedPublicVirtualInterface 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 HostedPublicVirtualInterface resource accepts the following input properties:
- Address
Family string - The address family for the BGP peer.
ipv4
oripv6
. - Bgp
Asn int - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- Connection
Id string - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- Owner
Account stringId - The AWS account that will own the new virtual interface.
- Route
Filter List<string>Prefixes - A list of routes to be advertised to the AWS network in this region.
- Vlan int
- The VLAN ID.
- Amazon
Address string - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- Bgp
Auth stringKey - The authentication key for BGP configuration.
- Customer
Address string - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- Name string
- The name for the virtual interface.
- Address
Family string - The address family for the BGP peer.
ipv4
oripv6
. - Bgp
Asn int - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- Connection
Id string - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- Owner
Account stringId - The AWS account that will own the new virtual interface.
- Route
Filter []stringPrefixes - A list of routes to be advertised to the AWS network in this region.
- Vlan int
- The VLAN ID.
- Amazon
Address string - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- Bgp
Auth stringKey - The authentication key for BGP configuration.
- Customer
Address string - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- Name string
- The name for the virtual interface.
- address
Family String - The address family for the BGP peer.
ipv4
oripv6
. - bgp
Asn Integer - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- connection
Id String - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- owner
Account StringId - The AWS account that will own the new virtual interface.
- route
Filter List<String>Prefixes - A list of routes to be advertised to the AWS network in this region.
- vlan Integer
- The VLAN ID.
- amazon
Address String - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- bgp
Auth StringKey - The authentication key for BGP configuration.
- customer
Address String - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- name String
- The name for the virtual interface.
- address
Family string - The address family for the BGP peer.
ipv4
oripv6
. - bgp
Asn number - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- connection
Id string - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- owner
Account stringId - The AWS account that will own the new virtual interface.
- route
Filter string[]Prefixes - A list of routes to be advertised to the AWS network in this region.
- vlan number
- The VLAN ID.
- amazon
Address string - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- bgp
Auth stringKey - The authentication key for BGP configuration.
- customer
Address string - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- name string
- The name for the virtual interface.
- address_
family str - The address family for the BGP peer.
ipv4
oripv6
. - 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_ strid - The AWS account that will own the new virtual interface.
- route_
filter_ Sequence[str]prefixes - A list of routes to be advertised to the AWS network in this region.
- 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_ strkey - 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.
- name str
- The name for the virtual interface.
- address
Family String - The address family for the BGP peer.
ipv4
oripv6
. - bgp
Asn Number - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- connection
Id String - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- owner
Account StringId - The AWS account that will own the new virtual interface.
- route
Filter List<String>Prefixes - A list of routes to be advertised to the AWS network in this region.
- vlan Number
- The VLAN ID.
- amazon
Address String - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- bgp
Auth StringKey - The authentication key for BGP configuration.
- customer
Address String - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- name String
- The name for the virtual interface.
Outputs
All input properties are implicitly available as output properties. Additionally, the HostedPublicVirtualInterface resource produces the following output properties:
- Amazon
Side stringAsn - Arn string
- The ARN of the virtual interface.
- Aws
Device string - The Direct Connect endpoint on which the virtual interface terminates.
- Id string
- The provider-assigned unique ID for this managed resource.
- Amazon
Side stringAsn - Arn string
- The ARN of the virtual interface.
- Aws
Device string - The Direct Connect endpoint on which the virtual interface terminates.
- Id string
- The provider-assigned unique ID for this managed resource.
- amazon
Side StringAsn - arn String
- The ARN of the virtual interface.
- aws
Device String - The Direct Connect endpoint on which the virtual interface terminates.
- id String
- The provider-assigned unique ID for this managed resource.
- amazon
Side stringAsn - arn string
- The ARN of the virtual interface.
- aws
Device string - The Direct Connect endpoint on which the virtual interface terminates.
- id string
- The provider-assigned unique ID for this managed resource.
- amazon_
side_ strasn - 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.
- amazon
Side StringAsn - arn String
- The ARN of the virtual interface.
- aws
Device String - The Direct Connect endpoint on which the virtual interface terminates.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing HostedPublicVirtualInterface Resource
Get an existing HostedPublicVirtualInterface 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?: HostedPublicVirtualInterfaceState, opts?: CustomResourceOptions): HostedPublicVirtualInterface
@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,
name: Optional[str] = None,
owner_account_id: Optional[str] = None,
route_filter_prefixes: Optional[Sequence[str]] = None,
vlan: Optional[int] = None) -> HostedPublicVirtualInterface
func GetHostedPublicVirtualInterface(ctx *Context, name string, id IDInput, state *HostedPublicVirtualInterfaceState, opts ...ResourceOption) (*HostedPublicVirtualInterface, error)
public static HostedPublicVirtualInterface Get(string name, Input<string> id, HostedPublicVirtualInterfaceState? state, CustomResourceOptions? opts = null)
public static HostedPublicVirtualInterface get(String name, Output<String> id, HostedPublicVirtualInterfaceState 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.
- Address
Family string - The address family for the BGP peer.
ipv4
oripv6
. - Amazon
Address string - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- Amazon
Side stringAsn - Arn string
- The ARN of the virtual interface.
- Aws
Device string - 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 stringKey - The authentication key for BGP configuration.
- Connection
Id string - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- Customer
Address string - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- Name string
- The name for the virtual interface.
- Owner
Account stringId - The AWS account that will own the new virtual interface.
- Route
Filter List<string>Prefixes - A list of routes to be advertised to the AWS network in this region.
- Vlan int
- The VLAN ID.
- Address
Family string - The address family for the BGP peer.
ipv4
oripv6
. - Amazon
Address string - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- Amazon
Side stringAsn - Arn string
- The ARN of the virtual interface.
- Aws
Device string - 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 stringKey - The authentication key for BGP configuration.
- Connection
Id string - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- Customer
Address string - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- Name string
- The name for the virtual interface.
- Owner
Account stringId - The AWS account that will own the new virtual interface.
- Route
Filter []stringPrefixes - A list of routes to be advertised to the AWS network in this region.
- Vlan int
- The VLAN ID.
- address
Family String - The address family for the BGP peer.
ipv4
oripv6
. - amazon
Address String - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- amazon
Side StringAsn - arn String
- The ARN of the virtual interface.
- aws
Device String - The Direct Connect endpoint on which the virtual interface terminates.
- bgp
Asn Integer - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- bgp
Auth StringKey - The authentication key for BGP configuration.
- connection
Id String - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- customer
Address String - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- name String
- The name for the virtual interface.
- owner
Account StringId - The AWS account that will own the new virtual interface.
- route
Filter List<String>Prefixes - A list of routes to be advertised to the AWS network in this region.
- vlan Integer
- The VLAN ID.
- address
Family string - The address family for the BGP peer.
ipv4
oripv6
. - amazon
Address string - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- amazon
Side stringAsn - arn string
- The ARN of the virtual interface.
- aws
Device string - The Direct Connect endpoint on which the virtual interface terminates.
- bgp
Asn number - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- bgp
Auth stringKey - The authentication key for BGP configuration.
- connection
Id string - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- customer
Address string - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- name string
- The name for the virtual interface.
- owner
Account stringId - The AWS account that will own the new virtual interface.
- route
Filter string[]Prefixes - A list of routes to be advertised to the AWS network in this region.
- vlan number
- The VLAN ID.
- address_
family str - The address family for the BGP peer.
ipv4
oripv6
. - amazon_
address str - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- amazon_
side_ strasn - 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_ strkey - 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.
- name str
- The name for the virtual interface.
- owner_
account_ strid - The AWS account that will own the new virtual interface.
- route_
filter_ Sequence[str]prefixes - A list of routes to be advertised to the AWS network in this region.
- vlan int
- The VLAN ID.
- address
Family String - The address family for the BGP peer.
ipv4
oripv6
. - amazon
Address String - The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
- amazon
Side StringAsn - arn String
- The ARN of the virtual interface.
- aws
Device String - The Direct Connect endpoint on which the virtual interface terminates.
- bgp
Asn Number - The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
- bgp
Auth StringKey - The authentication key for BGP configuration.
- connection
Id String - The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
- customer
Address String - The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
- name String
- The name for the virtual interface.
- owner
Account StringId - The AWS account that will own the new virtual interface.
- route
Filter List<String>Prefixes - A list of routes to be advertised to the AWS network in this region.
- vlan Number
- The VLAN ID.
Import
Using pulumi import
, import Direct Connect hosted public virtual interfaces using the VIF id
. For example:
$ pulumi import aws:directconnect/hostedPublicVirtualInterface:HostedPublicVirtualInterface 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.