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

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

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

    Create PrivateVirtualInterface Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new PrivateVirtualInterface(name: string, args: PrivateVirtualInterfaceArgs, opts?: CustomResourceOptions);
    @overload
def PrivateVirtualInterface(resource_name: str,
                            args: PrivateVirtualInterfaceArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def PrivateVirtualInterface(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            bgp_peers: Optional[Sequence[PrivateVirtualInterfaceBgpPeerArgs]] = None,
                            connection_id: Optional[str] = None,
                            vlan: Optional[int] = None,
                            allocate_private_virtual_interface_role_arn: Optional[str] = None,
                            direct_connect_gateway_id: Optional[str] = None,
                            enable_site_link: Optional[bool] = None,
                            mtu: Optional[int] = None,
                            tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                            virtual_gateway_id: Optional[str] = None,
                            virtual_interface_name: Optional[str] = None)
    func NewPrivateVirtualInterface(ctx *Context, name string, args PrivateVirtualInterfaceArgs, opts ...ResourceOption) (*PrivateVirtualInterface, error)
    public PrivateVirtualInterface(string name, PrivateVirtualInterfaceArgs args, CustomResourceOptions? opts = null)
    public PrivateVirtualInterface(String name, PrivateVirtualInterfaceArgs args)
public PrivateVirtualInterface(String name, PrivateVirtualInterfaceArgs args, CustomResourceOptions options)

    type: aws-native:directconnect:PrivateVirtualInterface
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 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.
    args PrivateVirtualInterfaceArgs
    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 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.
    name String
    The unique name of the resource.
    args PrivateVirtualInterfaceArgs
    The arguments to resource properties.
    options 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 Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The PrivateVirtualInterface resource accepts the following input properties:

    BgpPeers List<Pulumi.AwsNative.DirectConnect.Inputs.PrivateVirtualInterfaceBgpPeer>
    The BGP peers configured on this virtual interface.
    ConnectionId string
    The ID or ARN of the connection or LAG.
    Vlan int
    The ID of the VLAN.
    AllocatePrivateVirtualInterfaceRoleArn string
    The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
    DirectConnectGatewayId string
    The ID or ARN of the Direct Connect gateway.
    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.Inputs.Tag>
    The tags associated with the private virtual interface.
    VirtualGatewayId string
    The ID or ARN of the virtual private gateway.
    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 []PrivateVirtualInterfaceBgpPeerArgs
    The BGP peers configured on this virtual interface.
    ConnectionId string
    The ID or ARN of the connection or LAG.
    Vlan int
    The ID of the VLAN.
    AllocatePrivateVirtualInterfaceRoleArn string
    The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
    DirectConnectGatewayId string
    The ID or ARN of the Direct Connect gateway.
    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 TagArgs
    The tags associated with the private virtual interface.
    VirtualGatewayId string
    The ID or ARN of the virtual private gateway.
    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.
    vlan Integer
    The ID of the VLAN.
    allocatePrivateVirtualInterfaceRoleArn String
    The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
    directConnectGatewayId String
    The ID or ARN of the Direct Connect gateway.
    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.
    virtualGatewayId String
    The ID or ARN of the virtual private gateway.
    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.
    vlan number
    The ID of the VLAN.
    allocatePrivateVirtualInterfaceRoleArn string
    The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
    directConnectGatewayId string
    The ID or ARN of the Direct Connect gateway.
    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.
    virtualGatewayId string
    The ID or ARN of the virtual private gateway.
    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[PrivateVirtualInterfaceBgpPeerArgs]
    The BGP peers configured on this virtual interface.
    connection_id str
    The ID or ARN of the connection or LAG.
    vlan int
    The ID of the VLAN.
    allocate_private_virtual_interface_role_arn str
    The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
    direct_connect_gateway_id str
    The ID or ARN of the Direct Connect gateway.
    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[TagArgs]
    The tags associated with the private virtual interface.
    virtual_gateway_id str
    The ID or ARN of the virtual private gateway.
    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.
    vlan Number
    The ID of the VLAN.
    allocatePrivateVirtualInterfaceRoleArn String
    The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.
    directConnectGatewayId String
    The ID or ARN of the Direct Connect gateway.
    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.
    virtualGatewayId String
    The ID or ARN of the virtual private gateway.
    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 (-).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the PrivateVirtualInterface resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    VirtualInterfaceArn string
    The ID of the virtual interface.
    VirtualInterfaceId string
    The ID of the virtual interface.
    Id string
    The provider-assigned unique ID for this managed resource.
    VirtualInterfaceArn string
    The ID of the virtual interface.
    VirtualInterfaceId string
    The ID of the virtual interface.
    id String
    The provider-assigned unique ID for this managed resource.
    virtualInterfaceArn String
    The ID of the virtual interface.
    virtualInterfaceId String
    The ID of the virtual interface.
    id string
    The provider-assigned unique ID for this managed resource.
    virtualInterfaceArn string
    The ID of the virtual interface.
    virtualInterfaceId string
    The ID of the virtual interface.
    id str
    The provider-assigned unique ID for this managed resource.
    virtual_interface_arn str
    The ID of the virtual interface.
    virtual_interface_id str
    The ID of the virtual interface.
    id String
    The provider-assigned unique ID for this managed resource.
    virtualInterfaceArn String
    The ID of the virtual interface.
    virtualInterfaceId String
    The ID of the virtual interface.

    Supporting Types

    PrivateVirtualInterfaceBgpPeer, PrivateVirtualInterfaceBgpPeerArgs

    Information about a BGP peer.
    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, TagArgs

    A set of tags to apply to the resource.
    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.