AWS Classic
HostedTransitVirtualInterface
Provides a Direct Connect hosted transit 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 example = new Aws.DirectConnect.HostedTransitVirtualInterface("example", new Aws.DirectConnect.HostedTransitVirtualInterfaceArgs
{
ConnectionId = aws_dx_connection.Example.Id,
Vlan = 4094,
AddressFamily = "ipv4",
BgpAsn = 65352,
});
}
}
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.NewHostedTransitVirtualInterface(ctx, "example", &directconnect.HostedTransitVirtualInterfaceArgs{
ConnectionId: pulumi.Any(aws_dx_connection.Example.Id),
Vlan: pulumi.Int(4094),
AddressFamily: pulumi.String("ipv4"),
BgpAsn: pulumi.Int(65352),
})
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 example = new HostedTransitVirtualInterface("example", HostedTransitVirtualInterfaceArgs.builder()
.connectionId(aws_dx_connection.example().id())
.vlan(4094)
.addressFamily("ipv4")
.bgpAsn(65352)
.build());
}
}
import pulumi
import pulumi_aws as aws
example = aws.directconnect.HostedTransitVirtualInterface("example",
connection_id=aws_dx_connection["example"]["id"],
vlan=4094,
address_family="ipv4",
bgp_asn=65352)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.directconnect.HostedTransitVirtualInterface("example", {
connectionId: aws_dx_connection.example.id,
vlan: 4094,
addressFamily: "ipv4",
bgpAsn: 65352,
});
resources:
example:
type: aws:directconnect:HostedTransitVirtualInterface
properties:
connectionId: ${aws_dx_connection.example.id}
vlan: 4094
addressFamily: ipv4
bgpAsn: 65352
Create a HostedTransitVirtualInterface Resource
new HostedTransitVirtualInterface(name: string, args: HostedTransitVirtualInterfaceArgs, opts?: CustomResourceOptions);
@overload
def HostedTransitVirtualInterface(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 HostedTransitVirtualInterface(resource_name: str,
args: HostedTransitVirtualInterfaceArgs,
opts: Optional[ResourceOptions] = None)
func NewHostedTransitVirtualInterface(ctx *Context, name string, args HostedTransitVirtualInterfaceArgs, opts ...ResourceOption) (*HostedTransitVirtualInterface, error)
public HostedTransitVirtualInterface(string name, HostedTransitVirtualInterfaceArgs args, CustomResourceOptions? opts = null)
public HostedTransitVirtualInterface(String name, HostedTransitVirtualInterfaceArgs args)
public HostedTransitVirtualInterface(String name, HostedTransitVirtualInterfaceArgs args, CustomResourceOptions options)
type: aws:directconnect:HostedTransitVirtualInterface
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HostedTransitVirtualInterfaceArgs
- 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 HostedTransitVirtualInterfaceArgs
- 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 HostedTransitVirtualInterfaceArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HostedTransitVirtualInterfaceArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HostedTransitVirtualInterfaceArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
HostedTransitVirtualInterface 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 HostedTransitVirtualInterface 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.
- 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.
- 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- 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.
- 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.
- 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- 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.
- 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.
- 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- 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.
- 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.
- 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- 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.
- 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.
- 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- 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.
- 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.
- 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- name String
The name for the virtual interface.
Outputs
All input properties are implicitly available as output properties. Additionally, the HostedTransitVirtualInterface 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.
- Jumbo
Frame boolCapable Indicates whether jumbo frames (8500 MTU) are supported.
- 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.
- Jumbo
Frame boolCapable Indicates whether jumbo frames (8500 MTU) are supported.
- 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.
- jumbo
Frame BooleanCapable Indicates whether jumbo frames (8500 MTU) are supported.
- 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.
- jumbo
Frame booleanCapable Indicates whether jumbo frames (8500 MTU) are supported.
- 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.
- jumbo_
frame_ boolcapable Indicates whether jumbo frames (8500 MTU) are supported.
- 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.
- jumbo
Frame BooleanCapable Indicates whether jumbo frames (8500 MTU) are supported.
Look up an Existing HostedTransitVirtualInterface Resource
Get an existing HostedTransitVirtualInterface 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?: HostedTransitVirtualInterfaceState, opts?: CustomResourceOptions): HostedTransitVirtualInterface
@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) -> HostedTransitVirtualInterface
func GetHostedTransitVirtualInterface(ctx *Context, name string, id IDInput, state *HostedTransitVirtualInterfaceState, opts ...ResourceOption) (*HostedTransitVirtualInterface, error)
public static HostedTransitVirtualInterface Get(string name, Input<string> id, HostedTransitVirtualInterfaceState? state, CustomResourceOptions? opts = null)
public static HostedTransitVirtualInterface get(String name, Output<String> id, HostedTransitVirtualInterfaceState 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.
- Jumbo
Frame boolCapable Indicates whether jumbo frames (8500 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- Name string
The name for the virtual interface.
- Owner
Account stringId The AWS account that will own the new virtual interface.
- 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.
- Jumbo
Frame boolCapable Indicates whether jumbo frames (8500 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- Name string
The name for the virtual interface.
- Owner
Account stringId The AWS account that will own the new virtual interface.
- 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.
- jumbo
Frame BooleanCapable Indicates whether jumbo frames (8500 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- name String
The name for the virtual interface.
- owner
Account StringId The AWS account that will own the new virtual interface.
- 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.
- jumbo
Frame booleanCapable Indicates whether jumbo frames (8500 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- name string
The name for the virtual interface.
- owner
Account stringId 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
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.
- jumbo_
frame_ boolcapable Indicates whether jumbo frames (8500 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- name str
The name for the virtual interface.
- owner_
account_ strid The AWS account that will own the new virtual interface.
- 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.
- jumbo
Frame BooleanCapable Indicates whether jumbo frames (8500 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 transit interface can be either
1500
or8500
(jumbo frames). Default is1500
.- name String
The name for the virtual interface.
- owner
Account StringId The AWS account that will own the new virtual interface.
- vlan Number
The VLAN ID.
Import
Direct Connect hosted transit virtual interfaces can be imported using the vif id
, e.g.,
$ pulumi import aws:directconnect/hostedTransitVirtualInterface:HostedTransitVirtualInterface 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.