AWS::DirectConnect::PrivateVirtualInterface

DirectConnect PrivateVirtualInterface

Resource Type definition for AWS::DirectConnect::PrivateVirtualInterface

Properties

10 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`BgpPeers`	`Array<BgpPeer>`	Required
`ConnectionId`	`Any \| Any \| Any \| Any`	Required
`VirtualInterfaceName`	`string`	Required
`Vlan`	`integer`	RequiredCreate-only
`AllocatePrivateVirtualInterfaceRoleArn`	`string`	Create-onlyWrite-only
`DirectConnectGatewayId`	`Any \| Any`	Create-only
`EnableSiteLink`	`boolean`
`Mtu`	`integer`
`Tags`	`Array<Tag>`
`VirtualGatewayId`	`string`	Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`VirtualInterfaceArn`	`string`	The ID of the virtual interface.
`VirtualInterfaceId`	`string`	The ID of the virtual interface.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::DirectConnect::PrivateVirtualInterface

Resources:
  MyResource:
    Type: AWS::DirectConnect::PrivateVirtualInterface
    Properties:
      BgpPeers: []
      ConnectionId: "my-connectionid"
      VirtualInterfaceName: "my-virtualinterfacename"
      Vlan: 1
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

read

directconnect:DescribeVirtualInterfaces

create

directconnect:ConfirmPrivateVirtualInterfacedirectconnect:CreateBGPPeerdirectconnect:CreatePrivateVirtualInterfacedirectconnect:DescribeVirtualInterfacesdirectconnect:TagResourcests:AssumeRole

update

directconnect:AssociateVirtualInterfacedirectconnect:CreateBGPPeerdirectconnect:DeleteBGPPeerdirectconnect:DescribeVirtualInterfacesdirectconnect:TagResourcedirectconnect:UntagResourcedirectconnect:UpdateVirtualInterfaceAttributes

list

directconnect:DescribeVirtualInterfaces

delete

directconnect:DeleteVirtualInterfacedirectconnect:DescribeVirtualInterfaces

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceDirectConnect

Properties12

Required4

TaggingSupported

Primary IDVirtualInterfaceArn

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AllocatePrivateVirtualInterfaceRoleArnDirectConnectGatewayIdVirtualGatewayIdVlan

Related Resources

External Links

AWS Documentation