Skip to content
v2.273.0

CfnTransitVirtualInterfaceProps Struct ​

Properties for defining a CfnTransitVirtualInterface.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_directconnect as directconnect } from 'aws-cdk-lib';
const cfnTransitVirtualInterfaceProps: directconnect.CfnTransitVirtualInterfaceProps = {
  bgpPeers: [{
    addressFamily: 'addressFamily',
    asn: 'asn',

    // the properties below are optional
    amazonAddress: 'amazonAddress',
    authKey: 'authKey',
    bgpPeerId: 'bgpPeerId',
    customerAddress: 'customerAddress',
  }],
  connectionId: 'connectionId',
  directConnectGatewayId: 'directConnectGatewayId',
  virtualInterfaceName: 'virtualInterfaceName',
  vlan: 123,

  // the properties below are optional
  allocateTransitVirtualInterfaceRoleArn: 'allocateTransitVirtualInterfaceRoleArn',
  enableSiteLink: false,
  mtu: 123,
  rateLimit: 'rateLimit',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

allocateTransitVirtualInterfaceRoleArnstringallocate_transit_virtual_interface_role_arnstrallocateTransitVirtualInterfaceRoleArnStringAllocateTransitVirtualInterfaceRoleArnstringAllocateTransitVirtualInterfaceRoleArn*string#
The Amazon Resource Name (ARN) of the role to allocate the TransitVifAllocation.

Needs directconnect:AllocateTransitVirtualInterface permissions and tag permissions if applicable.

bgpPeersIResolvable | IResolvable | CfnTransitVirtualInterface.BgpPeerProperty[]bgp_peerstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, BgpPeerProperty]]]bgpPeersIResolvableBgpPeersIResolvableBgpPeersinterface{}required#
The BGP peers configured on this virtual interface..
connectionIdstring | IConnectionRef | ILagRefconnection_idtyping.Union[str, IConnectionRef, ILagRef]connectionIdStringConnectionIdstringConnectionIdinterface{}required#
directConnectGatewayIdstring | IDirectConnectGatewayRefdirect_connect_gateway_idtyping.Union[str, IDirectConnectGatewayRef]directConnectGatewayIdStringDirectConnectGatewayIdstringDirectConnectGatewayIdinterface{}required#
mtunumbermtuint | floatmtuNumberMtudoubleMtu*float64#
The maximum transmission unit (MTU), in bytes.

The supported values are 1500 and 9001. The default value is 1500.

rateLimitstringrate_limitstrrateLimitStringRateLimitstringRateLimit*string#
The rate limit (bandwidth allocation) for the virtual interface.

The value must be one of the supported bandwidth values (e.g., 50Mbps, 1Gbps, 10Gbps) and cannot exceed the bandwidth of the parent connection or LAG.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The tags associated with the private virtual interface.
virtualInterfaceNamestringvirtual_interface_namestrvirtualInterfaceNameStringVirtualInterfaceNamestringVirtualInterfaceName*stringrequired#
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 (-).

vlannumbervlanint | floatvlanNumberVlandoubleVlan*float64required#
The ID of the VLAN.

Used as props by ​