1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. directconnect
  5. getPrivateVirtualInterface

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.directconnect.getPrivateVirtualInterface

aws-native logo

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.57.0
published on Monday, Mar 9, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::DirectConnect::PrivateVirtualInterface

    Using getPrivateVirtualInterface

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getPrivateVirtualInterface(args: GetPrivateVirtualInterfaceArgs, opts?: InvokeOptions): Promise<GetPrivateVirtualInterfaceResult>
function getPrivateVirtualInterfaceOutput(args: GetPrivateVirtualInterfaceOutputArgs, opts?: InvokeOptions): Output<GetPrivateVirtualInterfaceResult>
    def get_private_virtual_interface(virtual_interface_arn: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetPrivateVirtualInterfaceResult
def get_private_virtual_interface_output(virtual_interface_arn: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetPrivateVirtualInterfaceResult]
    func LookupPrivateVirtualInterface(ctx *Context, args *LookupPrivateVirtualInterfaceArgs, opts ...InvokeOption) (*LookupPrivateVirtualInterfaceResult, error)
func LookupPrivateVirtualInterfaceOutput(ctx *Context, args *LookupPrivateVirtualInterfaceOutputArgs, opts ...InvokeOption) LookupPrivateVirtualInterfaceResultOutput

    > Note: This function is named LookupPrivateVirtualInterface in the Go SDK.

    public static class GetPrivateVirtualInterface 
{
    public static Task<GetPrivateVirtualInterfaceResult> InvokeAsync(GetPrivateVirtualInterfaceArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateVirtualInterfaceResult> Invoke(GetPrivateVirtualInterfaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateVirtualInterfaceResult> getPrivateVirtualInterface(GetPrivateVirtualInterfaceArgs args, InvokeOptions options)
public static Output<GetPrivateVirtualInterfaceResult> getPrivateVirtualInterface(GetPrivateVirtualInterfaceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:directconnect:getPrivateVirtualInterface
  arguments:
    # arguments dictionary

    The following arguments are supported:

    VirtualInterfaceArn string
    The ID of the virtual interface.
    VirtualInterfaceArn string
    The ID of the virtual interface.
    virtualInterfaceArn String
    The ID of the virtual interface.
    virtualInterfaceArn string
    The ID of the virtual interface.
    virtual_interface_arn str
    The ID of the virtual interface.
    virtualInterfaceArn String
    The ID of the virtual interface.

    getPrivateVirtualInterface Result

    The following output properties are available:

    BgpPeers List<Pulumi.AwsNative.DirectConnect.Outputs.PrivateVirtualInterfaceBgpPeer>
    The BGP peers configured on this virtual interface.
    ConnectionId string
    The ID or ARN of the connection or LAG.
    EnableSiteLink bool
    Indicates whether to enable or disable SiteLink.
    Mtu int
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    The tags associated with the private virtual interface.
    VirtualInterfaceArn string
    The ID of the virtual interface.
    VirtualInterfaceId string
    The ID of the virtual interface.
    VirtualInterfaceName string
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
    BgpPeers []PrivateVirtualInterfaceBgpPeer
    The BGP peers configured on this virtual interface.
    ConnectionId string
    The ID or ARN of the connection or LAG.
    EnableSiteLink bool
    Indicates whether to enable or disable SiteLink.
    Mtu int
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    Tags Tag
    The tags associated with the private virtual interface.
    VirtualInterfaceArn string
    The ID of the virtual interface.
    VirtualInterfaceId string
    The ID of the virtual interface.
    VirtualInterfaceName string
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
    bgpPeers List<PrivateVirtualInterfaceBgpPeer>
    The BGP peers configured on this virtual interface.
    connectionId String
    The ID or ARN of the connection or LAG.
    enableSiteLink Boolean
    Indicates whether to enable or disable SiteLink.
    mtu Integer
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    tags List<Tag>
    The tags associated with the private virtual interface.
    virtualInterfaceArn String
    The ID of the virtual interface.
    virtualInterfaceId String
    The ID of the virtual interface.
    virtualInterfaceName String
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
    bgpPeers PrivateVirtualInterfaceBgpPeer[]
    The BGP peers configured on this virtual interface.
    connectionId string
    The ID or ARN of the connection or LAG.
    enableSiteLink boolean
    Indicates whether to enable or disable SiteLink.
    mtu number
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    tags Tag[]
    The tags associated with the private virtual interface.
    virtualInterfaceArn string
    The ID of the virtual interface.
    virtualInterfaceId string
    The ID of the virtual interface.
    virtualInterfaceName string
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
    bgp_peers Sequence[PrivateVirtualInterfaceBgpPeer]
    The BGP peers configured on this virtual interface.
    connection_id str
    The ID or ARN of the connection or LAG.
    enable_site_link bool
    Indicates whether to enable or disable SiteLink.
    mtu int
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    tags Sequence[root_Tag]
    The tags associated with the private virtual interface.
    virtual_interface_arn str
    The ID of the virtual interface.
    virtual_interface_id str
    The ID of the virtual interface.
    virtual_interface_name str
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).
    bgpPeers List<Property Map>
    The BGP peers configured on this virtual interface.
    connectionId String
    The ID or ARN of the connection or LAG.
    enableSiteLink Boolean
    Indicates whether to enable or disable SiteLink.
    mtu Number
    The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.
    tags List<Property Map>
    The tags associated with the private virtual interface.
    virtualInterfaceArn String
    The ID of the virtual interface.
    virtualInterfaceId String
    The ID of the virtual interface.
    virtualInterfaceName String
    The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

    Supporting Types

    PrivateVirtualInterfaceBgpPeer

    AddressFamily string
    The address family for the BGP peer.
    Asn string
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    AmazonAddress string
    The IP address assigned to the Amazon interface.
    AuthKey string
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters.
    BgpPeerId string
    CustomerAddress string
    The IP address assigned to the customer interface.
    AddressFamily string
    The address family for the BGP peer.
    Asn string
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    AmazonAddress string
    The IP address assigned to the Amazon interface.
    AuthKey string
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters.
    BgpPeerId string
    CustomerAddress string
    The IP address assigned to the customer interface.
    addressFamily String
    The address family for the BGP peer.
    asn String
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    amazonAddress String
    The IP address assigned to the Amazon interface.
    authKey String
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters.
    bgpPeerId String
    customerAddress String
    The IP address assigned to the customer interface.
    addressFamily string
    The address family for the BGP peer.
    asn string
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    amazonAddress string
    The IP address assigned to the Amazon interface.
    authKey string
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters.
    bgpPeerId string
    customerAddress string
    The IP address assigned to the customer interface.
    address_family str
    The address family for the BGP peer.
    asn str
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    amazon_address str
    The IP address assigned to the Amazon interface.
    auth_key str
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters.
    bgp_peer_id str
    customer_address str
    The IP address assigned to the customer interface.
    addressFamily String
    The address family for the BGP peer.
    asn String
    The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
    amazonAddress String
    The IP address assigned to the Amazon interface.
    authKey String
    The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximum length of 80 characters.
    bgpPeerId String
    customerAddress String
    The IP address assigned to the customer interface.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    Viewing docs for AWS Cloud Control v1.57.0
    published on Monday, Mar 9, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Try Pulumi Cloud free. Your team will thank you.