AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::DirectConnect::PrivateVirtualInterface

CfnPrivateVirtualInterface

Resource Type definition for AWS::DirectConnect::PrivateVirtualInterface.

Import

import { CfnPrivateVirtualInterface } from 'aws-cdk-lib/aws-directconnect';

Or use the module namespace:

import * as directconnect from 'aws-cdk-lib/aws-directconnect';
// directconnect.CfnPrivateVirtualInterface

Properties

Configuration passed to the constructor as CfnPrivateVirtualInterfaceProps.

bgpPeersRequired
IResolvable | IResolvable | BgpPeerProperty[]

The BGP peers configured on this virtual interface.

connectionIdRequired
string | IConnectionRef | ILagRef
virtualInterfaceNameRequired
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 (-).

vlanRequired
number

The ID of the VLAN.

allocatePrivateVirtualInterfaceRoleArnOptional
string

The Amazon Resource Name (ARN) of the role to allocate the private virtual interface. Needs directconnect:AllocatePrivateVirtualInterface permissions and tag permissions if applicable.

directConnectGatewayIdOptional
string | IDirectConnectGatewayRef
enableSiteLinkOptional
boolean | IResolvable

Indicates whether to enable or disable SiteLink.

mtuOptional
number

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 9001. The default value is 1500.

tagsOptional
CfnTag[]

The tags associated with the private virtual interface.

virtualGatewayIdOptional
string

The ID or ARN of the virtual private gateway.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::DirectConnect::PrivateVirtualInterfaceView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-directconnect
CFN TypeAWS::DirectConnect::PrivateVirtualInterface
Properties10

Related Constructs

Explore This Service

External Links