AWS::DirectConnect::TransitVirtualInterface

DirectConnect TransitVirtualInterface

Resource Type definition for AWS::DirectConnect::TransitVirtualInterface

Properties

9 configurable properties. 5 required. Click a row to see details.

Filter:

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

Return Values

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

Attribute	Type	Description
`VirtualInterfaceArn`	`string`	The ARN 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::TransitVirtualInterface

Resources:
  MyResource:
    Type: AWS::DirectConnect::TransitVirtualInterface
    Properties:
      BgpPeers: []
      ConnectionId: "my-connectionid"
      DirectConnectGatewayId: "my-directconnectgatewayid"
      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:CreateTransitVirtualInterfacedirectconnect:ConfirmTransitVirtualInterfacedirectconnect:DescribeVirtualInterfacesdirectconnect:CreateBGPPeerdirectconnect:TagResourcests:AssumeRole

update

directconnect:UpdateVirtualInterfaceAttributesdirectconnect:AssociateVirtualInterfacedirectconnect:DescribeVirtualInterfacesdirectconnect:CreateBGPPeerdirectconnect:DeleteBGPPeerdirectconnect:TagResourcedirectconnect:UntagResource

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

Properties11

Required5

TaggingSupported

Primary IDVirtualInterfaceArn

Supported Operations

ReadCreateUpdateListDelete

Immutable After Creation

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

AllocateTransitVirtualInterfaceRoleArnDirectConnectGatewayIdVlan

Related Resources

External Links

AWS Documentation